SBC 5x00 3.0 CLI Reference Guide

Transcription

SBC 5x00 CLI Reference Guide
Session Border Controller
Sonus Technical Publication
www.sonusnet.com
Sonus Part Number:
Document Version:
Software Version:
550-05337
0.3
V03.00.00
Copyright
Copyright © 1999 - 2012 Sonus Networks, Inc. All rights reserved. Printed in the U.S.A.
This item and the information contained herein are the property of Sonus Networks, Inc. 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.
Third-Party Copyrights
Open BSD Copyright (c) 1982, 1986, 1990, 1991, 1993. The Regents of the University of California. All rights reserved.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the above disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
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.
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.
Warranties
THIS INFORMATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT.
REFERENCES TO CORPORATIONS, THEIR SERVICES AND PRODUCTS, ARE PROVIDED “AS IS” WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED. IN NO EVENT SHALL SONUS NETWORKS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS INFORMATION.
Descriptions of, or references to, products, services or publications within Sonus Networks' documentation do not imply endorsement of that
product, service or publication. Sonus Networks makes no warranty of any kind with respect to the subject matter included herein, the
products listed herein, or the completeness or accuracy of the information. Sonus Networks specifically disclaims all warranties, express,
implied or otherwise, including without limitation, all warranties of merchantability and fitness for a particular purpose.
THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES MAY BE
PERIODICALLY MADE TO THE INFORMATION HEREIN.
Trademarks
Sonus, the Sonus logo, Open Services Architecture, Insignus, SMART, Sonus Insight, SBC 5100TM, SBC 5200TM, IMX, NBS9000,
NBS4000, NBS4010, Atreus Systems, the Atreus logo, and Insight xAuthority are either registered trademarks or trademarks of Sonus
Networks, Inc. — Open Services Partner Alliance and SonusCARE are service marks of Sonus Networks, Inc.
The Sonus Networks, Inc. trademarks may not be used in connection with any product or service that is not Sonus Networks’ in any manner
that is likely to cause confusion among customers or in any manner that disparages or discredits Sonus Networks, Inc.
Third-Party Trademarks
Apache is the http server, and Tomcat is the Servlet/JSP container developed by the Apache Software Foundation. — Rapid
Service Introduction (RSI) System is a trademark of BayPackets, Inc. — Borland is a registered trademark, and AppServer is a
trademark of Borland Software Corporation. — Dot Hill and SANnet are trademarks of Dot Hill Systems Corp. — Eclipse is a
trademark of Eclipse Foundation, Inc. GoAhead and SelfReliant are registered trademarks of GoAhead Software, Inc. — IBM,
Netcool, Rational, ClearCase, and WebSphere are registered trademarks of International Business Machines Corporation in the
United States, other countries, or both. — Intel, Xeon, and Pentium are registered trademarks of Intel Corporation in the United
States and/or other countries. — Iomega is a registered trademark of the Iomega Corporation, a wholly owned subsidiary of the
EMC Corporation. — Macromedia is a registered trademark, and JRun is a trademark of Macromedia, Inc. in the U.S. and/or other
countries. — DataDirect is a registered trademark of Progress Software Corporation. — Linux is a registered trademark of Linus
Torvalds in the United States and/or other countries. — Microsoft, Microsoft Internet Explorer logo, Windows, Windows NT,
Windows XP, and/or other Microsoft products referenced herein are either registered trademarks or trademarks of Microsoft
Corporation in the U.S. and/or other countries. — MySQL is a registered trademark of MySQL AB in the United States, the
European Union and other countries. — Netscape is a registered trademark of Netscape Communications Corporation in the U.S.
and other countries. — Nokia is a registered trademark of Nokia Corporation. — Oracle, JD Edwards, PeopleSoft, and Siebel are
registered trademarks of Oracle Corporation and/or its affiliates. — Palm OS and Palm Powered are registered trademarks, and
Palm is a trademark owned by or licensed to Palm, Inc. — Red Hat, RPM, JBoss, and all Red Hat-based trademarks are
trademarks or registered trademarks of Red Hat, Inc. in the United States and/or other countries. — Sage Instruments is a
copyright of Sage Instruments, Inc. — Service Availability and the Service Availability logo are trademarks used with the permission
of their owner. — SnowShore, SnowShore Networks, and N20 are trademarks of Cantata Technology Inc. — SSH is an IETF
protocol and OpenSSH is a derivative of the original and free ssh 1.2.12 release by Tatu Ylonen. SSH Secure Shell is a trademark
of SSH Communications Security Corp. — Sun, Sun Microsystems, Java, JumpStart, Netra, Solaris, Solstice DiskSuite, and all
trademarks that contain Sun, Solaris, or Java are trademarks, registered trademarks, or service marks of Sun Microsystems, Inc. in
the United States and other countries. — iPlanet is a division of Sun Microsystems, Inc. — All SPARC trademarks are used under
license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing
SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. — Telcordia is a registered trademark
and LERG is a trademark of Telcordia Technologies, Inc. in the United States, other countries, or both. — Signalware is a registered
trademark of Ulticom, Inc. — UNIX is a registered trademark in the United States and other countries, exclusively licensed through
X/Open Company, Ltd. — VeriSign is a registered trademark, and Thawte Consulting is a wholly owned subsidiary of VeriSign, Inc.
— Veritas is a trademark of Symantec Corporation or its affiliates in the U.S. and other countries. — WebLogic is a registered
trademark of BEA Systems, Inc.
All other product names mentioned herein are trademarks, service marks, registered trademarks, or registered service marks of
their respective owners.
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
user’s own expense.
Compliance with Applicable Laws and Export Control Laws
Use of the information in this publication is governed by all applicable federal, state, and local laws. All information available in this
publication is subject to U.S. export control laws and may also be subject to the laws of the country where you reside. Sonus
Networks makes no representation that the content on this site is appropriate or available for use in other locations, and access to
it from territories where the content is illegal and prohibited.
All Sonus Networks, Inc. products and publications are commercial in nature. Use, duplication, or disclosure by the United States
Government is subject to the restrictions set forth in DFARS 252.227-7013 and FAR 52.227-19.
Embedded Software
Oracle Enterprise Edition is an embedded part of the Sonus product line. The programs included herein are subject to a restricted
use license and can only be used in conjunction with this application. You are not allowed to navigate or modify the underlying
database schema unless explicitly authorized in writing by Sonus.
TABLE OF CONTENTS
About This Guide
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
What’s in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Technical Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Documentation Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Chapter 1 Introduction to CLI Commands
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
SBC 5x00 CLI Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Logging in to the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Exiting the CLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
CLI Operations in Top-level CLI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Entering and Exiting the CLI Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
SBC 5x00 Provisioning Using Configuration Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
SBC 5x00 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Uppercase and Lowercase Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
CLI Command Line Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Chapter 2
General CLI Functionality
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Top-level Operations in SBC 5x00 CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
change-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
commit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
550-05337— Version 0.3 — Release V03.00.00
I–v
TOC
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
set-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Show CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
show configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
show notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
show table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-126
show users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-129
show utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-129
source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-131
top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-132
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-133
Chapter 3 Address Context
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
DNS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Creating and Configuring DNS Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
IP Access Control List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
IP Interface Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
IPsec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Link Detection Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Link Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-47
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48
Static Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Static IP Routes for IP interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Static Route for Management Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-65
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-65
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69
I–vi
© 2012 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
NBS5200 Applications Guide
TOC
Request Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
CMDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
DNS Server Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
IPSec Request Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
SIP Request Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
Zone Request Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117
Chapter 4 Global
Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Configuring Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Call Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Call Trace Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Call Trace Trigger Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Country . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
NPA/Nxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
DNS Server Global Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Configuring ENUM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
Configuring E911 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
Configuring Gateway Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
Configuring H323 Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
Configuring SIP Peer Overload Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
Configuring SIP Signaling Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
SIP Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48
550-05337 — Version 0.3 — Release V03.00.00
I–vii
TOC
Chapter 5 Operations and Maintenance (OAM)
Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configuring Call CDR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configuring External CDR Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Configuring Radius Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Configuring Radius Server for Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Configuring Radius Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Event Log Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Local Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
Authenticating users/groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Chapter 6 Profiles
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Supported Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Call Parameter Filter Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Call Routing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Crankback Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Element Routing Priority Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Holiday . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Time Range Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Digit Parameter Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Digit Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-57
DTMF Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64
Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66
Annoucement Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66
Codec Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-67
Packet Service Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78
Tone and Announcement Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-90
Tone Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-92
Tone Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-94
I–viii
NBS5200 Applications Guide
TOC
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-96
Crypto Suite Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-96
Key Management Protection Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-98
IPSec Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-100
TLS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-102
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-105
Class of Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-105
Emergency Call Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-108
SIP ARS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-110
Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-115
IP Signaling Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-115
ISUP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-157
Number Globalization Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-166
SIP Adaptor Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-171
SIP/CPC Cause Code Mapping Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-181
SIP CAC Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-189
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-189
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-191
System Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-192
Coredump Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-192
IP Policing Alarm Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-193
Overload Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201
Chapter 7 System
Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Congestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Congestion Policer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
DSP Packet Assembler Disassembler (PAD) Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Ethernet Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
Interval Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
Logical Management IP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28
I–ix
TOC
Media Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Management IP Interface Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34
Management Static Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
NTP Services Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
Policy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Global Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Local Policy Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-50
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-50
Remote Policy Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-54
Security Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58
IPsec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58
PKI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Server Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-62
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-62
I–x
About This Guide
Overview
The Sonus SBC 5x00 CLI Reference Guide describes how to use the CLI to
configure and manage the SBC 5x00 switch.
I–xi
Audience
This guide is intended for use by network engineers responsible for provisioning,
maintaining, and administering the SBC 5x00 Switch. The user should be familiar
with the Public Switched Telephone Network (PSTN) terminology, the LINUX
operating system and packet networking,
I–xii
What’s in This Guide
This guide contains the following information:
Chapter 1, "Introduction", provides an overview of the basic information about the
Sonus Session Border Controller platforms (SBC 5100 and SBC 5200) and main
features.
Chapter 1, "Introduction to CLI Commands", provides an overview of the CLI
components documented in this guide.
Chapter 2, "General CLI Functionality", provides an overview of the command line
interface (CLI) and information on configuring the SBC 5x00. A basic approach to
the configuration process is suggested and explained by examples.
Chapter 3, "Address Context", presents a description of address context object
and the CLI commands that you may use to create, configure, and view
information about it.
Chapter 4, "Global", presents a description of global object and the CLI
commands that you may use to create, configure, and view information about it.
Chapter 5, "Operations and Maintenance (OAM)", presents a description of
operation and maintenance object and the CLI commands that you may use to
create, configure, and view information about it.
Chapter 6, "Profiles", presents a description of profiles object and the CLI
Chapter 7, "System", presents a description of system object and the CLI
I–xiii
Conventions
This document uses the following text conventions to convey instructions and
information:
Convention
Indicates
Example
monospace text
System output, file
names, path names,
commands.
The show all command shows
all...
monospace bold text
User input.
Examine the configuration status:
show addressContext default
ipInterfaceGroup
monospace italics
Variables in
commands or code.
set addressContext
<addresscontextname>
italics
Document names,
emphasis, or manual
titles.
SBC 5x00 Operations Guide.
A note, caution, or
warning.
Refer to examples below.
RED TEXT:
Followed by bold
text
NOTE
Notes provide additional information or helpful suggestions that may
apply to the subject text, or in special cases — for example, memory
limitations, equipment configurations, or details that apply to specific
versions of
a product.
CAUTION
Cautions advise the reader that failure to take or avoid a specified
action could result in equipment damage or data loss.
WARNING
Warnings advise the reader that failure to take or avoid a specific action
could result in physical injury or harm.
I–xiv
Contacts
Technical Support
For problems or questions, contact the Sonus Technical Assistance Center (TAC):
USA Toll-free
1 (888) 391-3434
Worldwide Voice
1 (978) 614-8589
Worldwide Fax
1 (978) 614-8609
Web
https://customers.sonusnet.com
Technical Publications
Customer comments are welcome. If you have questions or comments about this
document, please address your feedback as follows:
•
•
E-mail: [email protected]
Address:
Sonus Networks, Inc.
Attn: Technical Publications
4 Technology Park Drive
Westford, MA 01886
USA
Documentation Updates
For updates to documents produced by Sonus Technical Publications, navigate to
the Support section of http://www.sonusnet.com and login under Documentation
Updates.
I–xv
I–xvi
CHAPTER 1
Introduction to CLI Commands
Overview
This chapter provides an overview of how to access the SBC 5x00 command-line
interface (CLI), the different command modes, and the operations that are
available in each mode. Topics include:
•
•
•
•
•
•
•
•
•
"SBC 5x00 CLI Modes" on page 1–2
"Logging in to the CLI" on page 1–3
"Exiting the CLI" on page 1–4
"CLI Operations in Top-level CLI Mode" on page 1–5
"Entering and Exiting the CLI Configuration Mode" on page 1–6
"SBC 5x00 Provisioning Using Configuration Mode" on page 1–7
"Uppercase and Lowercase Use" on page 1–9
"CLI Command Line Structure" on page 1–10
"Getting Help" on page 1–11
1–1
SBC 5x00 CLI Modes
SBC 5x00 CLI Modes
The SBC 5x00 CLI has two modes:
•
•
1–2
The top-level mode, which you are in when you first log in to the CLI. This
mode lets you view the current configuration and status of objects.
The configure mode lets you create/modify, show, and delete configurable
SBC 5x00 objects. For information on how to enter to the configure mode,
refer to "Entering and Exiting the CLI Configuration Mode" on page 1–6.
Logging in to the CLI
Perform the following steps to login to the SBC 5x00 CLI:
1.
SSH to the active CE. For example, if the active CE is server1, enter:
ssh admin@server1
NOTE
Local nodes are instantiated on one or more hardware entities within an SBC
5x00 and these hardware entities are called Computing Element (CE).
2.
When a prompt appears for the password, enter the password. The default
password is “admin”.
A message similar to the following appears:
admin connected from 10.1.1.19 using ssh on <server1>
This is followed by a prompt similar to the following:
admin@server1>
1–3
Exiting the CLI
Exiting the CLI
Perform the following steps to exit the SBC 5x00 CLI:
Exiting the CLI
1.
At the CLI prompt (for example, admin@server1>), enter:
admin@server1> exit
A message like the following appears:
Connection to server1 closed.
1–4
CLI Operations in Top-level CLI Mode
CLI Operations in Top-level CLI Mode
The following are the operations available in the top-level CLI mode:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
change-password - Change your password
commit - Confirm a pending commit
compare - Compare running configuration to another configuration or a file
configure - Manipulate software configuration information
exit - Exit the management session
help - Provide help information
quit - Exit the management session
request - Make system-level requests
reset - Reset the terminal
set - Set CLI properties
set-path - Set relative show path
show - Show information about the system
source - File to source
top - Exit to top level and optionally run command
up - Exit one level of configuration
For more information on the operations that can be performed in the SBC 5x00
top-level CLI mode, refer to "Top-level Operations in SBC 5x00 CLI" on page 2–2.
1–5
Entering and Exiting the CLI Configuration Mode
Entering and Exiting the CLI Configuration Mode
The following steps describe how to enter and exit the CLI configuration mode:
Using the CLI Edit Mode
1.
Log in to the CLI (refer to "Logging in to the CLI" on page 1–3).
2.
At the CLI prompt (for example, admin@server1>), enter:
admin@server1> configure <access_mode>
Where <access_mode> specifies the type of configuration access for the
session. Possible values are:
• exclusive: Only one exclusive session is possible at a time. Private sessions
are allowed during an exclusive session but the private sessions cannot commit
their changes. An exclusive session cannot start when a private session is in the
process of committing its changes.
• private: Multiple private sessions can occur simultaneously. Changes made in
a private session can be committed while other private sessions are open, which
updates the current configuration. If you enter “configure” then the default private
session is selected.
NOTE
Maximum of six simultaneous sessions can be
opened at a time including exclusive session.
A message similar to the following appears:
Entering configuration mode private
[ok][2009-01-05 17:06:22]
[edit]
admin@server1%
Note that the prompt in the configuration mode is followed by % rather than >.
3.
1–6
To exit the configuration mode, enter either quit or exit.
SBC 5x00 Provisioning Using Configuration Mode
The following are the operations are supported in exclusive and private
modes:
commit
- Commit current set of changes
delete
- Delete a data element
edit
- Edit a sub-element
exit
- Exit from this level
help
- Provide help information
quit
request
- Make system-level requests
resolved - Conflicts have been resolved
revert
- Copy configuration from running
rollback - Roll back database to last committed version
set
- Set a parameter
show
- Show a parameter
status
- Display users currently editing the configuration
top
- Exit to top level and optionally run command
up
- Exit one level of configuration
NOTE
When exclusive user is logged in to CLI, then private users cannot
commit their changes.
SBC 5x00 Objects
The CLI supports SBC 5x00 provisioning and managing of the following SBC
5x00 objects.
Example: To find the SBC 5x00 objects that can come next in a set command,
enter set and then enter a space followed by the ? key. The following is
displayed:
addressContext - A container of objects that correspond to
a specific
IP Addressing domain.
global
wide
- Global objects that are applicable Node
oam
- Operations and Maintenance objects.
1–7
profiles
- Profiles, such as digit profile, call
trace filter,
crankback, overload, congestion, dtmf
triggers, dsp
usage, and etc.
system
- System Management.
For more information on provisioning and managing SBC 5x00 objects, refer to
the respective chapters on the SBC 5x00 Objects.
1–8
Uppercase and Lowercase Use
Uppercase and Lowercase Use
The CLI commands are case-sensitive. Enter the commands as shown in this
guide.
WARNING
Please be aware that the CLI is case sensitive meaning that the objects/
profiles with names that differ only in case are distinct objects.
For example, trunkgroups with the following names are 3 distinct
trunkgroup entities: trunkgroup1, TRUNKGROUP1, TrunkGroup1. It is
strongly recommended that such naming practice be avoided.
1–9
CLI Command Line Structure
CLI Command Line Structure
When issuing a CLI command, the following structure is used:
<operation> <object type> <key(s)> <attribute name>
<attribute value> <attribute name> <attribute value> ...
Where:
<operation> is the operation to be performed, such as set. The operations that
are available for each object are shown in the respective chapters.
<object type> is the type of object on which you are performing the operation,
such as system.
<key(s)> is the string or strings that uniquely identify the object. A command
may have more than one key value.
<attribute name> is the name of an attribute. The attributes that can be used
with a specific operation are listed in the operations tables.
<attribute value> is the value you enter for an attribute. The possible values
for an attribute are described in the attribute tables in the respective chapters.
Example: Figure 1–1 shows the command that is used to create the
crankbackprofile with the name crankbackprofile2. The description of
these attributes and a list of the attributes that can be used for this object and
command are in Profiles chapter.
FIGURE 1–1 Example of set profiles
operation
key
object
set profiles callRouting crankbackProfile
crankbackprofile2 attemptRecordGeneration enabled
lateCrankback disabled
attribute value
attribute name
attribute value
attribute name
(To complete the creation of the crankbackProfile object, commit commands
and commands to set the mode and state are also required as described in "CLI
Operations in Top-level CLI Mode" on page 1–5.)
1–10
Getting Help
Getting Help
The Help feature is a fast and simple means to learn more about the available
commands and correct command syntax.
The following steps describe how to use the Help feature:
Getting Help in the CLI
1.
To see the top-level CLI commands that are available, at the CLI prompt (for
example, admin@server1>), type ?.
A list of the possible top-level commands appears:
commit
- Confirm a pending commit
compare
- Compare running configuration to another
configuration or a file
configure
information
- Manipulate software configuration
exit
- Exit the management session
help
quit
request
reset
- Reset the terminal
set
- Set CLI properties
set-path
- Set relative show path
show
- Show information about the system
source
- File to source
top
command
- Exit to top level and optionally run
up
1–11
Getting Help
Getting Help in the CLI (Continued)
2.
To see the possible entries that can come next in a top-level command
sequence, enter the first part of the command, and then enter a space
followed by ?.
Example: To find the entries that can come next in a show command, enter
show and then press the ?. The following is displayed:
Possible completions:
cli
- Display cli settings
configuration - Display current configuration
notification
- Display notifications
status
- Display current system status
table
- Display current configuration and status
as a table
users
- Display currently logged on users
utils
- System utilities
Example: To find the entries that can come next in a configure command,
enter configure and then enter a space followed by the ?. The following is
displayed:
exclusive
3.
private
If you are in the configuration mode (for example, you entered configure
private and the prompt is followed by a %, such as admin@server1%), then
type ? to see the commands that are available. The following is displayed:
commit
- Commit current set of changes
delete
- Delete a data element
edit
- Edit a sub-element
exit
help
quit
request
resolved - Conflicts have been resolved
revert
- Copy configuration from running
rollback - Roll back database to last committed version
1–12
set
- Set a parameter
show
- Show a parameter
status
- Display users currently editing the configuration
top
up
Getting Help
4.
If you are in the edit mode and want to see the possible entries that can
come next in a command sequence, enter the first part of the command and
then enter a space followed by ?.
? provides the full description and the possible completions.
Example: To find the entries that can come next in a set command, enter
set and then enter a space followed by the ?. The following is displayed:
addressContext - A container of objects that correspond to
a specific IP Addressing domain.
global
wide
oam
profiles
- Profiles, such as digit profile, call
trace filter, crankback, overload,
congestion, dtmf triggers, dsp usage,
and etc.
system
- System Management.
Example: To find the entries that can come next in a set global command,
enter set global and then enter a space followed by the Tab key. The
following is displayed:
callRouting
- Global call routing objects.
callTrace
- Call Trace Group configuration for the
carrier
- Carrier.
country
- Country Code.
security
- Global server objects.
servers
- Global server objects.
signaling
- Global Signaling objects
sipDomain
- SIP Domain.
subscriber
- Subscriber.
Node.
1–13
Getting Help
Example: To find the entries that can come next in a set global
callTrace command, enter set global callTrace and then enter a
space followed by ?. The following is displayed:
callFilter
- This table contains call trace filters
the node.
errorFilter
- The error filter to apply system wide.
maxTriggerCount - The trigger count for both call and
error trace filters.
1–14
CHAPTER 2
Overview
This chapter provides information on the operations that are available in the SBC
5x00 top-level CLI mode. It lists the operations that are available, the command
syntax, lists the attributes, and provides command examples. Topics include:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
"Top-level Operations in SBC 5x00 CLI" on page 2–2
"change-password" on page 2–3
"commit" on page 2–4
"configure" on page 2–6
"exit" on page 2–8
"help" on page 2–9
"quit" on page 2–10
"request" on page 2–11
"set" on page 2–16
"set-path" on page 2–17
"show" on page 2–18
"source" on page 2–131
"top" on page 2–132
"up" on page 2–133
2–1
Top-level Operations in SBC 5x00 CLI
Top-level Operations in SBC 5x00 CLI
This section describes the operations that can be performed in the SBC 5x00 toplevel CLI mode and provides examples for these operations. These examples
assume you are logged on to admin@server1. CLI Top Level Commands.
To see the top-level CLI commands that are available, at the CLI prompt (for
example, admin@server1>), type ?. A list of the possible top-level commands
appears:
admin@merc> ?
commit
- Confirm a pending commit
compare
- Compare running configuration to another
configuration or a file
configure - Manipulate software configuration information
exit
help
quit
request
reset
- Reset the terminal
set
- Set CLI properties
set-path
- Set relative show path
show
- Show information about the system
source
- File to source
top
up
Each command details are explained in the following sub-sections.
2–2
change-password
change-password
The change-password operation allows you to change the password. It is
recommended that you should change the password from the default when you
log in for the first time.
NOTE
The new password entered should not be same as user name.
Command Syntax
> change-password <password>
2–3
commit
commit
If you are issuing a set, edit or delete command in the top-level CLI mode or
configuration mode, you need to perform a commit for the changes to take effect
but a commit is not required for a request command in the top-level CLI mode.
In addition, any command that changes the mode or state of an object must be
entered and committed separately. The examples under the set command
description include the appropriate commit entries.
NOTE
The SBC 5x00 limits the number of SET operations that can be
committed at once. You should issue a commit before more than
approximately 100 field values have been modified.
2–4
compare
compare
This command compares the running configuration to another configuration or a
file.
Command Syntax
> compare file <fileName>
addressContext <addressContext>
brief <brief>
global <global>
oam <oam>
profiles <profiles>
system <system>
Command Parameters
TABLE 2–1
Compare Parameters
Parameter
Field
Length
Description
fileName
N/A
Specifies the name of the files to be compared.
addressContex N/A
t
Specifies the objects scoped to a specific IP addressing domain.
brief
N/A
Specifies to show only differences.
global
N/A
Specifies the global objects that are applicable Node wide.
oam
N/A
Specifies the Operations and Maintenance objects.
profiles
N/A
Specifies the profiles of configuration shared by multiple objects.
system
N/A
Specifies the system-level configuration.
2–5
configure
configure
The configuration mode lets you create or modify, show, and delete configurable
SBC 5x00 objects.
SBC 5x00 can be configured using two modes:
•
•
exclusive: Only one exclusive session is possible at a time. Private
sessions are allowed during an exclusive session but the private sessions
cannot commit their changes. An exclusive session cannot start when a
private session is in the process of committing its changes. For more
information on exclusive mode commands, refer to "SBC 5x00 Provisioning
Using Configuration Mode" on page 1–7.
private: Multiple private sessions can occur simultaneously. Changes made
in a private session can be committed while other private sessions are open,
which updates the current configuration. If you enter configure then the
default private session is selected.
Command Syntax
> configure <access_mode>
Command Parameters
TABLE 2–2
Configure Mode Parameters
Parameter
Field
Length
access_mode
N/A
Description
Specifies the type of configuration access for the session.
Possible values are:
• exclusive
• private
Command Example
To configure SBC 5x00 in private mode:
admin@server1> configure private
2–6
configure
NOTE
Maximum of six simultaneous sessions can be opened at a time
including exclusive session.
2–7
exit
exit
The exit operation is used to exit from the CLI management session.
2–8
help
help
The help operation is a fast and simple means to learn more about the available
commands and correct command syntax. For more information, refer to "Getting
Help" on page 1–11.
2–9
quit
quit
The quit operation is used to exit the top-level CLI mode or configuration mode.
2–10
request
request
The request operation is used to initiate an action on an object.
Command Syntax
To ping other system from SBC 5x00:
> request addressContext default cmds optionsPing
peerIpAddress <peerIpAddress>
peerPort <peerPort>
sigPort <sigPort>
transport (tcp|tls|udp)
Command Parameters
TABLE 2–3
CMDS Parameters
Parameter
Field
Length
Description
addressContex 1-23
t
Specifies the name of the address context. The address
context is a container of objects that correspond to a
specific IP Addressing domain. Must be 1-23 characters.
peerIpAddress 1-32
Specifies the Peer SIP Address to ping. Enter IPv4 address
in the following format:
• IPv4 - This is V4 IP address in dotted decimal form (for
example 128.127.50.224).
peerPort
N/A
Specifies the Peer SIP Port Number to ping.
sigPort
N/A
Specifies the Signaling Port to use for the ping.
transport
N/A
Specifies the Transport Protocol to use. Select any one of
the following transport type:
• tcp
• tls
• udp
To initiate action on DNS group object:
> request addressContext <addressContext> dnsGroup <dnsGroup>
dnsServerReset
2–11
request
Command Parameters
TABLE 2–4
DNS Group Parameters
Field
Length
Parameter
Description
addressContex
t
1-23
dnsGroup
1-32
Specifies the name of this DNS Group Entry. Must be 1-23
characters.
dnsServerRese
t
N/A
Resets all the DNS server statistics.
To initiate action on IPsec object:
> request addressContext <addressContext> ipsec
ikeSaDelete <ikeSaDelete> | ikeSaDeleteAll <ikeSaDeleteAll>
|
ipsecSaDelete <ipsecSaDelete>
Command Parameters
TABLE 2–5
IPsec Parameters
Parameter
Field
Length
ikeSaDelete
N/A
Specifies the name of a specific IKE SA to be deleted by its
IKE handle identifier.
ikeSaDeleteAl
l
N/A
To globally delete every IKE SA.
ipsecSaDelete
N/A
Delete the IPsec SA pair with a given local tunnel IP
address (LOCAL TUNNEL IP ADDRESS) and a given
incoming Security Parameter Index value (LOCAL SPI).
Description
To reset the SIP Registration and SIP subscription:
> request addressContext <addressContext> sipRegCountReset
> request addressContext <addressContext>
sipRegistrationDeleteById <RegistrationId>
>
request addressContext <addressContext>
sipRegistrationDeleteByIp ipAddress <ipAddress>
> request addressContext <addressContext> sipSubCountReset
> request addressContext <addressContext>
sipSubscriptionDelete <SubcriptionId>
2–12
request
Command Parameters
TABLE 2–6
SIP Registration and SIP Subscription Parameters
Field
Length
Description
sipRegCountRes
et
N/A
Resets the SIP registration count.
sipRegistratio
nDeleteById
N/A
Delete a SIP registration by ID.
sipRegistratio
nDeleteByIp
N/A
Delete a SIP registration by IP address.
sipSubCountRes
et
N/A
Reset the SIP subscription count.
sipSubscriptio
nDelete
N/A
Delete a SIP subscription
Parameter
To reset Zone parameters:
> request addressContext <addressContext> zone <zone>
sipSigConnResetAll
sipSigPortResetAll
sipTrunkGroup <sipTrunkGroup> packetOutage clear
Command Parameters
TABLE 2–7
SIP Registration and SIP Subscription Parameters
Parameter
Field
Length
Description
sipSigConnRese
tAll
N/A
Set operation on this object resets all the statistics counts
to zero on all signaling ports.
sipSigPortRese
tAll
N/A
Set operation on this object resets all the statistics counts
to zero on all signaling ports.
sipTrunkGroup
N/A
Specifies the SIP trunk groups in this zone.
To clear alarms:
> request alarms clear <current | history>
To initiate action on global object:
> request global callCountReset
To stop background job operations:
> request job stop <job id>
> request message <all | username>
2–13
request
To initiate action on accounting objects:
> request oam accounting cdrServer admin
> request oam alarms resetIpPolicingAlarmStatus
> request oam eventLog filterStatus <filterStatus>
To initiate action on system objects:
> request system admin systemname
identify <identify>
loadConfig <loadConfig>
removeTransferredFile <removeTransferredFile>
restart <restart>
revertSoftwareUpgrade <revertSoftwareUpgrade>
saveConfig <saveConfig>
softReset <softReset>
startSoftwareUpgrade <startSoftwareUpgrade>
stopFileTransfer <stopFileTransfer>
switchover <switchover>
transferFile <transferFile>
> request system congestion
> request system ipPolicing resetOffendersList name
aclOffendersList
aggregateOffendersList
arpOffendersList
badEtherIpHdrOffendersList
discardRuleOffendersList
ipSecDecryptOffendersList
mediaOffendersList
rogueMediaOffendersList
uFlowOffendersList
> request system logout user <username | sessionid>
> request system policyServer remoteServer <remoteServer>
Command Example
To clear all alarms from the history buffer:
admin@server1> request alarms clear history
Deleted all alarm entries in history-table
2–14
reset
reset
The reset operation is used to reset the terminal.
2–15
set
set
The set operation is used in the top-level CLI mode and configuration mode, and
is used to create or modify an object.
Command Syntax
To automatically query for mandatory elements:
> set autowizard <true | false>
To enable/disable completion on space:
> set complete-on-space
To set show command display level:
> set display-level <depth>
To configure history size:
> set history <size>
To ignore leading whitespace:
> set ignore-leading-space <true | false>
To copy terminal output
> set output file <terminal|filename>
To paginate output from CLI commands
> set paginate <true|false>
To configure screen height and width:
> set screen length <numberofrows>
width <numberofcolumns>
To show default values when showing the configuration:
> set show defaults <true|false>
To set terminal type:
> set terminal <generic|xterm|vt100|ansi|linux>
2–16
set-path
set-path
The set-path operation is used set the relative show path for the SBC 5x00
objects.
To find the entries that can come next in the set-path command, enter setpath ?, the following is displayed:
addressContext - Objects scoped to a specific IP addressing
domain.
alarms
- Alarm Management
global
wide
oam
profiles
- Profiles of configuration shared by
multiple objects.
system
- System-level configuration.
2–17
show
show
The show operation is used in the top-level CLI mode or configuration mode. The
show command in the top-level CLI mode shows the following objects and their
attributes.
•cli
•configuration
•
notification
•status
•table
•users
•utils
Show CLI
This command displays the CLI settings.
> show cli history <number of items to show>
TABLE 2–8
CLI History Parameters
Parameter
Field
Length
Description
history
N/A
Displays CLI command history.
number of items to
show
N/A
Specifies the number of CLI command history
item to display.
Example:
To show CLI history, the following would be given:
admin@server1> show cli history 5677
06:11:44 -- show cli history 34
06:14:35 -- show cli history 5677
show configuration
The show configuration command displays the current configuration of the
SBC 5x00 system. It displays the configuration of the following SBC 5x00 objects:
2–18
•
address context
•
details
show
•
display level
•
global
•
oam (Operation and Maintenance)
•
profiles
•
system
show notification
The show notification command displays the current notifications of the
SBC 5x00 system.
Command Syntax
To display the current notifications of the SBC 5x00 system:
show notification stream
no
event
streams
present
show status
The show status command displays the current status of the SBC 5x00
system. It displays the status of the following SBC 5x00 objects:
•
address context
•
alarms
•
display level
•
global
•
•
system
Command Syntax
To display different levels of output information in show status command:
> show status displaylevel <displaylevel>
Example
To display two levels of output information of the show status command:
2–19
show
admin@server1> show status displaylevel 2
addressContext default {
dnsGroup dns;
dnsGroup dns_s;
ipInterfaceGroup ipinterface;
ipRouteStatus "" 0.0.0.0 0 10.6.81.1 eth0;
ipRouteStatus "" 0.0.0.0 0 10.6.82.1 mgt0;
ipRouteStatus "" 10.7.0.0 16 0.0.0.0 pkt0;
ipRouteStatus "" 10.7.0.0 16 0.0.0.0 pkt2;
linkDetectionGroup linkgrp;
linkDetectionGroupStatus linkgrp;
linkDetectionGroupStatistics linkgrp;
sipRegCountStatistics entry;
sipSubCountStatistics entry;
zone DNS;
zone defaultSigZone;
zoneStatus DNS;
zoneStatus defaultSigZone;
zoneCurrentStatistics DNS;
...
...
...
[ok][2011-02-09 07:43:06]
Command Syntax
To display status of address context objects:
> show status addressContext <addressContext>
ipInterfaceGroup <ipInterfaceGroup> ipInterfaceStatus
<ipInterfaceStatus>
operState <operState>
oosReason <oosReason>
rxPackets <rxPackets>
txPackets <txPackets>
2–20
show
numCalls <numCalls>
allocatedBandwidth <allocatedBandwidth>
actualBandwidth <actualBandwidth>
bwDeviation <bwDeviation>
> show status addressContext <addressContext> dnsGroup
<dnsGroup>
dnsEntryDataStatus
dnsEntryStatus
dnsServerStatistics
> show status addressContext <addressContext> ipRouteStatus
<ipRouteStatus>
protocol<bbnSpfIgp|bgp|ciscoEigrp|ciscoIgrp|egp|esIs
|ggp|hello|icmp|idpr|isIs|local|netmgmt|ospf|other|rip>
show status addressContext ipAccessControlList
displaylevel
ipAclOverallStatistics
ipAclRuleStatistics
ipAclRulesByPrecedence
>
show status addressContext <addressContext>
ipAccessControlList
ipAclOverallStatistics matchedNoRule <matchedNoRule>
ipAccessControlList
ipAclRuleStatistics
name
policerDiscards
>
show status addressContext <addressContext>
ipAccessControlList
ipAclRulesByPrecedence <precedenceVal>
displaylevel
matches
name
policerDiscards
ipAccessControlList
displaylevel <displaylevel>
linkDetectionGroup
linkMonitorStatus <linkMonitorStatus>
monitorStatus <monitorStatus>
linkStatus <linkStatus>
linkDetectionGroup
linkMonitorStatistics
minTime <minTime>
maxTime <maxTime>
averageTime <averageTime>
singleFailures <singleFailures>
doubleFailures <doubleFailures>
2–21
show
failures <failures>
replies <replies>
duplicateReplies <duplicateReplies>
lateReplies <lateReplies>
>
show status addressContext <addressContext> ipsec
systemStatistics <system-name>
ikeSaNegotiationsFailed
inPacketDiscardInvalidSpi
inPacketDiscardSAExpired
ipsecSaNegotiationsSucceeded
outPacketDiscardSAExpired
ikeSaNegotiationsSucceeded
inPacketDiscardNoState
inPacketDiscardSelectorMismatch
outPacketDiscardDiscarded
outPacketDiscardSSNWrap
inPacketDiscardDiscarded
inPacketDiscardProtected
ipsecSaNegotiationsFailed
outPacketDiscardProtected
sipRegCountStatistics
sipRegCountAttempts
sipRegCountCumCompletions
sipRegCountPending
sipRegCountStable
sipRegCountTotal
sipSubCountStatistics
sipSubCountAttempts
sipSubCountCumCompletions
sipSubCountStable
sipSubCountTotal
> show status addressContext <addressContext> zone <zone>
callCurrentStatistics
callFailureCurrentStatistics
callFailureIntervalStatistics
callIntervalStatistics
displaylevel
gwSigPortStatistics
gwSigPortStatus
h323SigPortStatistics
h323SigPortStatus
sipArsStatus
sipCurrentStatistics
sipIntervalStatistics
sipPeerCacStatus
sipSigConnStatistics
sipSigConnStatus
sipSigPortStatistics
2–22
show
sipSigPortStatus
sipSigPortTlsStatistics
sipSigTlsSessionStatus
sonusSipSigPeerOvldStatusEntry
trunkGroupStatus
sipCurrentStatistics
byeRetransmit
cancleReTransmit
emergencyAccept
emergencyRejectBWCall
emergencyRejectPolicer
hpcAccept
invReTransmit
otherReTransmit
rcv1xx
rcv2xx
rcv3xx
rcv4xx
rcv5xx
rcv6xx
rcv18x
rcvAck
rcvBye
rcvCancel
rcvInfo
rcvInvite
rcvMessage
rcvNonInv2xx
rcvNonInvErr
rcvNotify
rcvOption
rcvPrack
rcvPublish
rcvRefer
rcvRegister
rcvSubscriber
rcvUnknownMsg
rcvUpdate
regReTransmit
snd1xx
snd2xx
snd3xx
snd4xx
snd5xx
snd6xx
snd18x
sndAck
sndBye
sndCancel
sndInfo
sndInvite
sndMessage
2–23
show
sndNonInv2xx
sndNonInvErr
sndNotify
sndOption
sndPrack
sndPublish
sndRefer
sndRegister
sndSubscriber
sndUpdate
sipIntervalStatistics
byeRetransmit
cancleReTransmit
emergencyAccept
emergencyRejectBWCall
emergencyRejectPolicer
hpcAccept
intervalValid
invReTransmit
otherReTransmit
rcv1xx
rcv2xx
rcv3xx
rcv4xx
rcv5xx
rcv6xx
rcv18x
rcvAck
rcvBye
rcvCancel
rcvInfo
rcvInvite
rcvMessage
rcvNonInv2xx
rcvNonInvErr
rcvNotify
rcvOption
rcvPrack
rcvPublish
rcvRefer
rcvRegister
rcvSubscriber
rcvUnknownMsg
rcvUpdate
regReTransmit
snd1xx
snd2xx
snd3xx
snd4xx
snd5xx
snd6xx
2–24
show
snd18x
sndAck
sndBye
sndCancel
sndInfo
sndInvite
sndMessage
sndNonInv2xx
sndNonInvErr
sndNotify
sndOption
sndPrack
sndPublish
sndRefer
sndRegister
sndSubscriber
sndUpdate
time
sipSigPortStatus
state
callRate
origCalls
termCalls
txPdus
rxPdus
txBytes
rxBytes
inRegs
outRegs
sipSigConnStatus
aging
bytesRcvd
bytesSent
idleTime
index
pduRecvQueued
pduSendQueued
peerIpAddress
peerPortNum
role
socket
state
transport
sipSigConnStatistics
tcpConnection
totalTcpConnection
2–25
show
activeTlsTcpConnection
totalTlsTcpConnection
sipSigPortTlsStatistics
clientAuthFailures
currentClientHandshakes
currentClientSessions
currentServerHandshakes
currentServerSessions
currentSuspendedSessions
fatelAlertsReceived
handshakeFailures
handshakeTimeouts
higherAuthTimeout
midConnectionHello
noAuth488
noAuthDrops
noCipherSuite
noClientCert
receiveFailures
sendFailures
serverAuthFailures
sessionResumptions
totalClientSessions
totalServerSessions
warningAlertsReceived
callCurrentStatistics
activeRegs
callSetupTime
callSetups
callsWithPktOutage
callsWithPktOutageAtEnd
callsWithPsxDips
inBwUsage
inCallAttempts
inCalls
inUsage
maxActiveBwUsage
maxActiveCalls
maxActiveRegs
maxPktOutage
outBwUsage
outCallAttempts
outCalls
outUsage
playoutBufferAcceptable
playoutBufferGood
playoutBufferPoor
playoutBufferUnacceptable
podEvents
2–26
show
routingAttempts
sipRegAttempts
sipRegCompletions
totalPktOutage
totalPsxDips
callIntervalStatistics
activeRegs
callSetupTime
callSetups
callsWithPktOutage
callsWithPktOutageAtEnd
callsWithPsxDips
inBwUsage
inCallAttempts
inCalls
inUsage
intervalValid
maxActiveBwUsage
maxActiveCalls
maxActiveRegs
maxPktOutage
outBwUsage
outCallAttempts
outCalls
outUsage
playoutBufferAcceptable
playoutBufferGood
playoutBufferPoor
playoutBufferUnacceptable
podEvents
routingAttempts
sipRegAttempts
sipRegCompletions
time
totalPktOutage
totalPsxDips
callFailureCurrentStatistics
allocFailBwLimit
allocFailCallLimit
callAbandoned
callFailPolicing
inCallFailInvalidCall
inCallFailNetworkFailure
inCallFailNoResources
inCallFailNoRoutes
inCallFailNoService
inCallFailProtocolError
inCallFailUnspecified
invalidSPCallsFailed
2–27
show
noPsxRoute
nonMatchSrcIpCallsFail
outCallFailInvalidCall
outCallFailNetworkFailure
outCallFailNoResources
outCallFailNoRoutes
outCallFailNoService
outCallFailProtocolError
outCallFailUnspecified
regCallsFailed
routingFailuresResv
securityFail
sipRegFailInternal
sipRegFailOther
sipRegFailPolicing
callFailureIntervalStatistics
allocFailBwLimit
allocFailCallLimit
callAbandoned
callFailPolicing
inCallFailInvalidCall
inCallFailNetworkFailure
inCallFailNoResources
inCallFailNoRoutes
inCallFailNoService
inCallFailProtocolError
inCallFailUnspecified
intervalValid
invalidSPCallsFailed
noPsxRoute
nonMatchSrcIpCallsFail
nonRegCallsFailed
outCallFailInvalidCall
outCallFailNetworkFailure
outCallFailNoResources
outCallFailNoRoutes
outCallFailNoService
outCallFailProtocolError
outCallFailUnspecified
routingFailuresResv
securityFail
sipRegFailInternal
sipRegFailOther
sipRegFailPolicing
time
trunkGroupStatus
bandwidthAvailable
bandwidthCurrentLimit
2–28
show
bwInboundUsage
bwOutboundUsage
callsAvailableTotal
callsConfiguredTotal
inboundCallsUsage
outboundCallsUsage
packetOutDetectState
priorityCallUsage
state
totalCallsInboundReserved
totalOutboundCallsReserved
> show status addressContext <addressContext> zoneStatus
activeSipRegCount
bandwidthAvailable
bandwidthCurrentLimit
bwInboundUsage
bwOutboundUsage
callsAvailableTotal
callsConfiguredTotal
emergencyCallsBwUsage
inboundCallsUsage
outboundCallsUsage
priorityCallUsage
zoneCurrentStatistics
egressFailBWLimit
egressFailCallLimit
egressFailCallPolicing
egressSipRegFailLimit
egressSipRegPolicing
ingressFailBWLimit
ingressFailCallLimit
ingressFailCallPolicing
ingressSipRegFailLimit
ingressSipRegPolicing
zoneIntervalStatistics
egressFailBWLimit
egressFailCallLimit
egressFailCallPolicing
egressSipRegFailLimit
egressSipRegPolicing
ingressFailBWLimit
ingressFailCallLimit
ingressFailCallPolicing
ingressSipRegFailLimit
ingressSipRegPolicing
intervalValid
2–29
show
time
Command Parameters
TABLE 2–9
Address Context Parameters
Parameter
Field
Length
addressContext
1-23
ipInterfaceGro
up
N/A
Specifies the name of an IP interface group. Enter IP
interface group or select any to match any IP interface
group.
2–30
Description
show
TABLE 2–9
Parameter
Field
Length
ipInterfaceSta N/A
tus
Description
Specifies the status of the IP interfaces in this IP interface
group. The possible options are:
• actualBandwidth - Specifies the actual bandwidth in use
on this IP interface.
• allocatedBandwidth - Specifies the bandwidth allocated
on this IP interface.
• bwDeviation - Specifies the amount of deviation from the
actual bandwidth.
• ifindex - Specifies the interface index of the LIF.
• numCalls - Specifies the number of active call legs on this
IP interface.
• oosReason - Specifies the out-of-service reason for this IP
interface.
-
admin
linkDown
notApplicable
portDown
serverDown
standby
• operState - Specifies the operational state.
-
admnDisabled
admnEnabled
deallocDryup
deallocForce1
deallocForce2
null
remoteCreated
remoteCreating
resAllocated
resAllocating
• rxPackets - Specifies the number of packets received on
this IP interface.
• txPackets - Specifies the number of packets sent on this
IP interface.
dnsGroup
1-32
Specifies the name of this DNS Group Entry. Must be 123 characters. The possible options are:
• dnsEntryDataStatus - Specifies the DNS entry data
status.
• dnsEntryStatus - Specifies the DNS entry record status.
• dnsServerStatistics - Specifies the DNS server
statistics for this address context.
2–31
TABLE 2–9
show
Parameter
Field
Length
ipRouteStatus
N/A
Description
Specifies the name which identifies the local interface
through which the next hop of this route must be reached.
Options are:
• protocol - Specifies the routing mechanism through which
this route was learned.
-
2–32
bbnSpfIgp
bgp
ciscoEigrp
ciscoIgrp
egp
esIs
ggp
hello
icmp
idpr
isIs
local
netmgmt
ospf
other
rip
show
TABLE 2–9
Parameter
ipAccessContro
lList
Field
Length
N/A
Description
Specifies the IP Access Control lists for this address
context. Options are:
• displaylevel - To display different levels of output
information in show commands.
• ipAclOverallStatistics - Specifies the IP access
control list statistics.
- matchedNoRule - Specifies the number of times no rule
has been matched.
- displaylevel - To display different levels of output
• ipAclRuleStatistics - Specifies the IP access control
list rule statistics.
- matches - Specifies the number of times no rule has
been matched.
• ipAclRulesByPrecedence - Specifies the IP access
control list rules by precedence.
- matches - Specifies the number of times no rule has
been matched.
- name - Specifies the name of this IP access control list
rule.
- policerDiscard - Specifies the number of times the
policer for this rule discarded packets.
displaylevel
1-64
To display different levels of output information in show
commands.
linkMonitorSta
tus
N/A
The status of link verification for an IP interface. The
possible options are:
• linkStatus - Specifies the current link verification status
for this IP interface.
• monitorStatus - Specifies the current status of link
monitoring for this IP interface.
2–33
TABLE 2–9
show
Parameter
linkMonitorSta
tistics
Field
Length
N/A
Description
Specifies the statistics for link failure detected per IP
interface. The possible options are:
• averageTime - Specifies the average time (in
microseconds) used to get a reply for an echo request
packet.
• doubleFailures - Specifies the number of double failures
• duplicateReplies - Specifies the number of duplicate
replies.
• failures - Specifies the number of failures for this IP
interface.
• lateReplies - Specifies the number of late replies.
• maxTime - Specifies the maximum time (in microseconds)
used to get a reply for an echo request packet.
• minTime - Specifies the minimum time (in microseconds)
used to get a reply for an echo request packet.
• replies - Specifies the total number of replies.
• singleFailures - Specifies the number of single failures
system-name
2–34
N/A
Specifies the name of Ipsec system.
show
TABLE 2–9
Parameter
systemStatisti
cs
Field
Length
Description
N/A
Specifies the system statistics for Ipsec. Options are:
• ikeSaNegotiationsFailed - Specifies the number of
phase-1 (Main Mode) Security Association negotiation
failures.
• ikeSaNegotiationsSucceeded - Specifies the number
of phase-1 (Main mode) Security Association negotiations
resulting in a phase-1 SA being established.
• inPacketDiscardDiscarded - Specifies the number of
incoming ISAKMP packets discarded as a result of matching
a discard SPD rule.
• inPacketDiscardInvalidSpi - Specifies the incoming
ESP packets discarded due to their SPI not matching an
existing phase-2 SA.
• inPacketDiscardNoState - Specifies the number of
a discard no state rule.
• inPacketDiscardProtected - Specifies the number of
a protect SPD rule.
• inPacketDiscardSAExpired - Specifies the number of
incoming ESP packets discarded since they arrived on a
phase-2 SA that has expired.
• inPacketDiscardSelectorMismatch - Specifies the
number of Incoming ESP packets discarded due to selector
mismatch.
• ipsecSaNegotiationsFailed - Specifies the number of
phase-2 (Quick Mode) Security Association negotiation
failures.
• ipsecSaNegotiationsSucceeded - Specifies the
number of successful phase-2 (Quick Mode) Security
Association negotiations.
• outPacketDiscardDiscarded - Specifies the number of
outgoing ISAKMP packets discarded as a result of matching
a discard SPD rule.
• outPacketDiscardProtected - Specifies the number of
outgoing ISAKMP packets discarded as a result of matching
a protect SPD rule.
• outPacketDiscardSAExpired - Specifies the number of
outgoing ESP packets discarded since they are for a phase2 SA that has expired.
• outPacketDiscardSSNWrap - Specifies the number of
outgoing ESP packets discarded due to wrapping around of
the sequence number.
2–35
TABLE 2–9
show
Parameter
sipRegCountSta
tistics
Field
Length
N/A
Description
Specifies the SIP registration count statistics for the node.
The possible options are:
• sipRegCountAttempts - Specifies the number of SIP
registration attempts on SBC 5x00.
• sipRegCountCumCompletions - Specifies the
accumulative number of completed SIP registration attempts
on SBC 5x00.
• sipRegCountPending - Specifies the current number of
pending SIP registrations.
• sipRegCountStable - Specifies the current number of
stable SIP registrations.
• sipRegCountTotal - Specifies the total number of current
SIP registrations.
sipSubCountSta
tistics
N/A
Specifies the SIP relayed subscription count statistics for
the node. The possible options are:
• sipSubCountAttempts - Specifies the number of SIP
relayed subscription attempts on this card.
• sipSubCountCumCompletions - Specifies the
accumulative number of completed SIP subscription
attempts on this card.
• sipSubCountStable - Specifies the current number of
stable SIP subscription on this card.
• sipSubCountTotal - Specifies the total number of current
SIP subscription on this card.
zone
1-23
Specifies the name of the zone. Must be 1-23 characters.
You can configure signaling, media, and control for a
zone in the address context. The possible options are:
• callCurrentStatistics - Specifies the trunk group
current call statistics.
• callFailureCurrentStatistics - Specifies the trunk
group current call failure statistics.
• callFailureIntervalStatistics - Specifies the call
failure statistics for all trunk groups in this zone for past
intervals.
• callIntervalStatistics - Specifies the call related
statistics for all trunk groups in this zone for past intervals.
• gwSigPortStatistics - This table contains status of the
active signaling channels with other gateways.
• gwSigPortStatus - Specifies the SIP Signaling port
status.
2–36
show
TABLE 2–9
Parameter
zone
(continued)
Field
Length
1-23
Description
• h323SigPortStatistics - Specifies the H323 Signaling
Port Statistics.
• h323SigPortStatus - Specifies the H323 Signaling Port
Status.
• sipArsStatus - Specifies the Address Reachability
Service status.
• sipCurrentStatistics - Specifies the SIP trunk group
current SIP statistics.
• sipIntervalStatistics - Specifies the SIP trunk group
interval SIP statistics.
• sipPeerCacStatus - Specifies the status for SIP peers
with endpoint CAC configured.
• sipSigConnStatistics - Specifies the SIP Signaling
Port Connection statistics.
• sipSigConnStatus - This table contains status of the SIP
Signaling Port connection.
• sipSigPortStatistics - Specifies the SIP Signaling
Port Statistics.
• sipSigPortStatus - Specifies the SIP Signaling Port
Status.
• sipSigPortTlsStatistics - Specifies the SIP Signaling
TLS Connection statistics.
• sipSigTlsSessionStatus - This table contains the
status of SIP Signaling Port TLS session.
• sonusSipSigPeerOvldStatusEntry - Specifies the SIP
Signaling Peer Overload Status.
• trunkGroupStatus - Specifies the status for IP trunk
groups in this zone.
2–37
TABLE 2–9
Parameter
sipIntervalSta
tistics
2–38
show
Field
Length
Description
N/A
The SIP trunk group interval SIP statistics. Options are:
• byeRetransmit - Specifies the total number of (interval)
Bye messages ReTransmitted.
• cancleReTransmit - Specifies the total number of
(interval) Cancel messages ReTransmitted.
• emergencyAccept - Specifies the total number of (interval)
emergency calls accepted.
• emergencyRejectBWCall - Specifies the total number of
(interval) emergency calls rejected because of bandwidth
limit or call limit.
• emergencyRejectPolicer - Specifies the total number of
(interval) emergency calls rejected because of Priority
Policer.
• hpcAccept - Specifies the total number of (interval) HPC
calls accepted.
• intervalValid - Specifies the member indicating the
validity of the interval.
• invReTransmit - Specifies the total number of (interval)
Invite messages Re-transmitted.
• otherReTransmit - Specifies the total number of (interval)
Other messages ReTransmitted.
• rcv1xx - Specifies the total number of (interval) received
1xx msg except 18x messages.
2xx (Invite) messages.
3xx messages.
4xx messages.
• rcv5xx - Specifies the total number of (interval) receive 5xx
messages.
• rcv6xx - Specifies the total number of (interval) receive 6xx
messages.
• rcv18x - Specifies the total number of (interval) received
18x messages.
• rcvAck - Specifies the total number of (interval) received
Ack.
• rcvBye - Specifies the total number of (interval) received
Bye messages.
• rcvCancel - Specifies the total number of (interval)
received Cancel messages.
• rcvInfo - Specifies the total number of (interval) received
INFO messages.
show
TABLE 2–9
Parameter
sipIntervalSta
tistics
(continued)
Field
Length
N/A
Description
• rcvInvite - Specifies the total number of (interval)
received Invite messages.
• rcvMessage - Specifies the total number of (interval)
received Message method.
• rcvNonInv2xx - Specifies the total number of (interval)
received 2xx (NonInvite) messages.
• rcvNonInvErr - Specifies the total number of (interval)
receive NonIvite Error messages.
• rcvNotify - Specifies the total number of (interval) receive
notify messages.
• rcvOption - Specifies the total number of (interval) receive
Option messages.
• rcvPrack - Specifies the total number of (interval) received
Prack messages.
• rcvPublish - Specifies the total number of (interval)
received Publish method.
• rcvRefer - Specifies the total number of (interval) received
Refer messages.
• rcvRegister - Specifies the total number of (interval)
received Register messages.
• rcvSubscriber - Specifies the total number of (interval)
receive Subscriber messages.
• rcvUnknownMsg - Specifies the total number of (interval)
receive Unknown messages.
• rcvUpdate - Specifies the total number of (interval)
received Update messages.
• regReTransmit - Specifies the total number of (interval)
Register messages ReTransmitted.
• snd1xx - Specifies the total number of (interval) sent 1xx
msg except 18x messages.
(Invite) messages.
messages.
messages.
messages.
messages.
• snd18x - Specifies the total number of (interval) sent 18x
messages.
• sndAck - Specifies the total number of (interval) Sent Ack
messages.
2–39
TABLE 2–9
show
Parameter
Field
Length
Description
sipIntervalSta
tistics
(continued)
N/A
• sndBye - Specifies the total number of (interval) sent Bye
messages.
• sndCancel - Specifies the total number of (interval) sent
Cancel messages.
• sndInfo - Specifies the total number of (interval) sent INFO
messages.
• sndInvite - Specifies the total number of (interval) sent
Invite messages.
• sndMessage - Specifies the total number of (interval) sent
Message method.
• sndNonInv2xx - Specifies the total number of (interval)
sent 2xx (NonInvite) messages.
• sndNonInvErr - Specifies the total number of (interval)
sent NonIvite Error messages.
• sndNotify - Specifies the total number of (interval) sent
Notify messages.
• sndOption - Specifies the total number of (interval) sent
Option messages.
• sndPrack - Specifies the total number of (interval) sent
Prack messages.
• sndPublish - Specifies the total number of (interval) sent
Publish method.
• sndRefer - Specifies the total number of (interval) sent
Refer messages.
• sndRegister - Specifies the total number of (interval) sent
Register messages.
• sndSubscriber - Specifies the total number of (interval)
sent Subscriber messages.
• sndUpdate - Specifies the total number of (interval) sent
Update messages.
• time - The system up time when the interval statistics is
collected.
sipSigPortStat
us
N/A
The SIP signaling port status. Options are:
2–40
• state - Specifies the state of the SIP signaling port.
show
TABLE 2–9
Field
Length
Description
sipSigPortStat
istics
N/A
Specifies the SIP Signaling port statistics. Options are:
sipSigConnStat
us
N/A
Parameter
• callRate - Specifies the number of SIP calls per second
during the last minute.
• inRegs - Specifies the total number of inbound
registration(s) received.
• origCalls - Specifies the total number of outgoing calls
sent.
• outRegs - Specifies the total number of outbound
registration(s) sent.
• rxBytes - Specifies the total number of signaling BYTES
received.
• rxPdus - Specifies the total number of signaling PDUs
received.
• termCalls - Specifies the total number of incoming calls
received.
• txBytes - Specifies the total number of signaling BYTES
sent.
• txPdus - Specifies the total number of signaling PDUS sent.
Specifies the SIP Signaling Port connection status data.
Options are:
• aging - Specifies whether or not an idle connection can be
taken down.
• bytesRcvd - Specifies the number of payload bytes
received on the connection.
• bytesSent - Specifies the number of payload bytes sent on
the connection.
• idleTime - Specifies the time internal since the last activity.
• index - Specifies the index of this SIP Signaling Port.
• pduRecvQueued - Specifies the number of fragmented
PDUs received on the connection.
• pduSendQueued - Specifies the number of PDUs waiting to
be sent on the connection.
• peerIpAddress - Specifies the IP address of the peer of
this connection.
• peerPortNum - Specifies the port number used by the peer
of this connection.
• role - Specifies the role taken by the SBC 5x00 in this
connection.
2–41
TABLE 2–9
show
Parameter
sipSigConnStat
us (continued)
Field
Length
N/A
sipSigConnStat N/A
istics
Description
• socket - Specifies the socket number used internally for the
connection.
• state - Specifies the state of this connection.
• transport - Specifies the transport type used for the
connection.
Specifies the SIP Signaling port connection statistics.
Options are:
• activeTlsTcpConnection - Specifies the number of
current TLS-TCP connections made.
• tcpConnection - Specifies the number of current TCP
connections.
• totalTcpConnection - Specifies the number of total TCP
connections made.
• totalTlsTcpConnection - Specifies the number of total
TLS-TCP connections.
sipSigPortTlsS
tatistics
N/A
Specifies the SIP Signaling TLS connection statistics.
Options are:
• clientAuthFailures - Specifies the number of times
peer failed TLS authentication with SBC as the client.
• currentClientHandshakes - Specifies the number of
incomplete client handshakes.
• currentClientSessions - Specifies the number of client
sessions currently active.
• currentServerHandshakes - Specifies the number of
incomplete server handshakes.
• currentServerSessions - Specifies the number of
server sessions currently active.
• currentSuspendedSessions - Specifies the number of
server sessions currently suspended.
• fatelAlertsReceived - Specifies the number of FATAL
Alerts received.
• handshakeFailures - Specifies the cumulative total of all
handshake failures.
• handshakeTimeouts - Specifies the number of
handshakes that timed out before completing.
2–42
show
TABLE 2–9
Parameter
sipSigPortTlsS
tatistics
Field
Length
N/A
Description
• higherAuthTimeout - Specifies the number of
handshakes in which the SBC was the server and the client
did not authenticate itself through TLS and failed to
authenticate itself through any higher level protocol
• midConnectionHello - Specifies the number times a
peer sent a TLS Hello on a connection that was already up
• noAuth488 - Specifies the number of SIP messages
rejected with 488 due to lack of peer authentication at the
SIP level.
• noAuthDrops - Specifies the number of SIP messages
dropped due to lack of peer authentication at the SIP level.
• noCipherSuite - Specifies the number of handshake
failures due to inability to converge on a cipher suite.
• noClientCert - Specifies the number times we were the
client and we failed to derive a certificate to send the server.
• receiveFailures - Specifies the number of receive
failures (failure to decrypt).
• sendFailures - Specifies the number of send failures
(failure to encrypt).
• serverAuthFailures - Specifies the number of times
peer failed TLS authentication with SBC as the server.
• sessionResumptions - Specifies the number of server
sessions that have been resumed.
• totalClientSessions - Specifies the cumulative total
number of client sessions.
• totalServerSessions - Specifies the cumulative total
number of server sessions.
• warningAlertsReceived - Specifies the number of
WARNING Alerts received.
2–43
TABLE 2–9
show
Parameter
callCurrentSta
tistics
Field
Length
N/A
Description
Specifies the statistics of the trunk group call. Options
are:
• activeRegs - Specifies the current number of active
registrations on this trunk group.
• callSetupTime - Specifies the current total call setup time
for all completed calls in the inbound and outbound
directions for this trunk group measured in hundredths of a
second.
• callSetups - Specifies the current total number of calls
setup but not necessarily completed in the inbound and
outbound directions for this trunk group.
• callsWithPktOutage - Specifies the number of calls with
a maximum packet outage whose duration exceeds the
configured minimum for this trunk group.
• callsWithPktOutageAtEnd - Specifies the number of
calls whose maximum packet outage occurs at the end of
the call for this trunk group.
• callsWithPsxDips - Specifies the current number of calls
that made a PSX Dip.
• inBwUsage - Specifies the sum of bandwidth usage
(expected data rate in Kbits per second multiplied by call
duration in seconds) for every inbound call associated with
this trunk group.
• inCallAttempts - Specifies the current number of
inbound call attempts on this trunk group.
• inCalls - Specifies the current number of completed
inbound calls on this trunk group.
• inUsage - Specifies the current usage in the inbound
direction for this trunk group in seconds.
• maxActiveBwUsage - Specifies the high water mark of
bandwidth usage in either direction associated with this trunk
group.
• maxActiveRegs - Specifies the current number of
maximum active registrations on this trunk group (this is the
high-watermark achieved on this trunkgroup).
• maxActiveCalls - Specifies the current high water mark of
total number of active calls in both the inbound and
outbound directions on the trunk group. This is a statistic
accounts for calls that are setting up, stable, or tearing down.
• maxPktOutage - Specifies the single longest maximum
reported packet outage duration (in milliseconds)
experienced during the current performance interval for this
trunk group.
2–44
show
TABLE 2–9
Parameter
callCurrentSta
tistics
(continued)
Field
Length
N/A
Description
• outBwUsage - Specifies the sum of bandwidth usage
(expected data rate in Kbits per second multiplied by call
duration in seconds) for every outbound call associated with
this trunk group.
• outCallAttempts - Specifies the current number of
outbound call attempts on this trunk group.
• outCalls - Specifies the current number of completed
outbound calls on this trunk group.
• outUsage - Specifies the current usage in the outbound
direction for this trunk group in seconds.
• playoutBufferAcceptable - Specifies the number of
calls with all sub-intervals reporting ACCEPTABLE or better
playout buffer quality for this trunk group.
• playoutBufferGood - Specifies the number of calls with
all sub-intervals reporting GOOD playout buffer quality for
this trunk group.
• playoutBufferPoor - Specifies the number of calls with
all sub-intervals reporting POOR or better playout buffer
quality for this trunk group.
• playoutBufferUnacceptable - Specifies the number of
calls with at least one sub-interval reporting
UNACCEPTABLE playout buffer quality for this trunk group.
• podEvents - Specifies the number of Packet Outage
Detection (POD) Events detected for this trunk group.
• routingAttempts - Specifies the current number of
routing attempts for this trunk group.
• sipRegAttempts - Specifies the current number of SIP
registration attempts on a trunk group.
• sipRegCompletions - Specifies the current number of SIP
registrations that have successfully completed on a trunk
group.
• totalPktOutage - Specifies the summation of all packet
outage durations (in milliseconds) whose duration exceeds
the configured minimum, which is experienced during the
current performance interval for this trunk group.
• totalPsxDips - Specifies the current number of PSX Dips
made.
2–45
TABLE 2–9
Parameter
show
Field
Length
callIntervalSt N/A
atistics
Description
Specifies the trunk group interval call statistics. Options
are:
• activeRegs - Specifies the interval number of active
registrations on this trunk group.
• callSetupTime - Specifies the total call setup time for all
completed calls in the inbound and outbound directions for
this trunk group for the specified interval measured in
hundredths of a second.
• callSetups - Specifies the total number of calls setup but
not necessarily completed in the inbound and outbound
directions for this trunk group for the specified interval.
• callsWithPktOutage - Specifies the number of calls with
a maximum packet outage whose duration exceeds the
configured minimum for this trunk group for the specified
interval.
• callsWithPktOutageAtEnd - Specifies the number of
calls whose maximum packet outage occurs at the end of
the call for this trunk group for the specified interval.
• callsWithPsxDips - Specifies the number of calls that
made a PSX Dip in the interval
• inBwUsage - Specifies the sum of bandwidth usage
(expected data rate in bits per second multiplied by call
duration in seconds) for every inbound call associated with
this trunk group for the specified interval.
• inCallAttempts - Specifies the number of inbound call
attempts on this trunk group for the specified interval.
• inCalls - Specifies the number of completed inbound calls
on this trunk group for the specified interval.
• inUsage - Specifies the usage in the inbound direction for
this trunk group in seconds in the current interval. The trunk
group usage is defined as the time a trunk is seized to the
time a trunk is released.
• maxActiveBwUsage - Specifies the high water mark of
bandwidth usage in either direction associated with this trunk
group for the specified interval.
• maxActiveRegs - Specifies the Interval number of
maximum active registrations on this trunk group (this is the
high-watermark achieved on this trunk group).
• maxActiveCalls - Specifies the current high water mark of
total number of active calls in both the inbound and
outbound directions on the trunk group for the specified
interval. This is a statistic accounts for calls that are setting
up, stable, or tearing down.
2–46
show
TABLE 2–9
Parameter
Field
Length
callIntervalSt N/A
atistics
(continued)
Description
• maxPktOutage - Specifies the single longest maximum
reported packet outage duration (in milliseconds)
experienced during the specified performance interval for
this trunk group.
• outBwUsage - Specifies the sum of bandwidth usage
(expected data rate in bits per second multiplied by call
duration in seconds) for every outbound call associated with
• outCallAttempts - Specifies the number of outbound call
attempts on this trunk group for the specified interval.
• outCalls - Specifies the number of completed outbound
calls on this trunk group for the specified interval.
• outUsage - Specifies the usage in the outbound direction
for this trunk group in seconds in the current interval. The
trunk group usage is defined as the time a trunk is seized to
the time a trunk is released.
• playoutBufferAcceptable - Specifies the number of
calls with all sub-intervals reporting ACCEPTABLE or better
playout buffer quality for this trunk group for the specified
interval.
• playoutBufferGood - Specifies the number of calls with
all sub-intervals reporting GOOD playout buffer quality for
• playoutBufferPoor - Specifies the number of calls with
all sub-intervals reporting POOR or better playout buffer
quality for this trunk group for the specified interval.
• playoutBufferUnacceptable - Specifies the number of
calls with at least one sub-interval reporting
UNACCEPTABLE playout buffer quality for this trunk group
for the specified interval.
• podEvents - Specifies the number of Packet Outage
Detection (POD) Events detected for this peer group for the
specified interval.
• routingAttempts - Specifies the number of routing
attempts for this trunk group for the specified interval.
• sipRegAttempts - Specifies the current number of SIP
registration attempts on a trunk group for the specified
interval.
• sipRegCompletions - Specifies the current number of SIP
registrations that have successfully completed on a trunk
• time - Specifies the system up time when the interval
statistics is collected.
2–47
TABLE 2–9
Parameter
show
Field
Length
Description
callIntervalSt N/A
atistics
(continued)
• totalPktOutage - Specifies the summation of packet
outage durations (in milliseconds) whose duration exceeds
the configured minimum which is reported during the
specified performance interval.
• totalPsxDips - The number of PSX Dips in the interval.
callFailureCur N/A
rentStatistics
Specifies the trunk group current call failure statistics.
2–48
• allocFailBwLimit - Specifies the number of bandwidth
requests which fail because the configured bandwidth limit
has been exceeded for this trunk group.
• allocFailCallLimit - Specifies the number of
bandwidth requests which fail because configured call limit
has been exceeded for this trunk group.
• callAbandoned - Specifies the current number of calls on
a trunk group that were abandoned while dialing.
• callFailPolicing - Specifies the current number of calls
on a trunk group that failed due to policing.
• displaylevel - To display different levels of output information
in show commands.
• inCallFailInvalidCall - Specifies the current number
of inbound failed calls because there was an invalid call
attempt for this trunk group.
• inCallFailNetworkFailure - Specifies the current
number of inbound failed calls because there was a network
failure for this trunk group.
• inCallFailNoResources - Specifies the current number
of inbound failed calls because there was an unavailable
resource for this trunk group.
• inCallFailNoRoutes - Specifies the current number of
inbound failed calls because there was no route available for
this trunk group.
• inCallFailNoService - Specifies the current number of
inbound failed calls because there was an unavailable
service for this trunk group.
• inCallFailProtocolError - Specifies the current
number of inbound failed calls because there was a protocol
error for this trunk group.
• inCallFailUnspecified - Specifies the current number
of inbound failed calls for an unspecified reason for this trunk
group.
• invalidSPCallsFailed - Specifies the current number
of calls that failed due to mismatched ingress signaling port
from CP according to RCB.
• noPsxRoute - Specifies the current number of calls on an
ingress trunk group that failed due to no routes.
show
TABLE 2–9
Parameter
Field
Length
callFailureCur N/A
rentStatistics
(continued)
Description
• nonMatchSrcIpCallsFail - Specifies the current number
of calls that failed due to mismatched source IP of IAD
according to its RCB.
• outCallFailInvalidCall - Specifies the current number
of outbound failed calls because there was an invalid call
attempt for this trunk group.
• outCallFailNetworkFailure - Specifies the current
number of outbound failed calls because there was a
network failure for this trunk group.
• outCallFailNoResources - Specifies the current number
of outbound failed calls because there was an unavailable
resource for this trunk group.
• outCallFailNoRoutes - Specifies the current number of
outbound failed calls because there was no route available
for this trunk group.
• outCallFailNoService - Specifies the current number of
outbound failed calls because there was an unavailable
service for this trunk group.
• outCallFailProtocolError - Specifies the current
number of outbound failed calls because there was a
protocol error for this trunk group.
• outCallFailUnspecified - Specifies the current number
of outbound failed calls for an unspecified reason for this
trunk group.
• regCallsFailed - Specifies the current number of calls
that failed due to registration requirement for SIP trunk
group.
• routingFailuresResv - Specifies the current number of
routing failures due to no un-reserved circuits available for
this trunk group.
• securityFail - Specifies the current number of calls that
failed due to a mismatch between the peer security and
route packet service profile security on a trunk group.
• sipRegFailInternal - Specifies the current number of
SIP registration attempts that failed due to internal
conditions (congestion, call admission, resources, etc.) on a
trunk group.
• sipRegFailOther - Specifies the current number of SIP
registration attempts that failed due to other reasons
(signaling failures, etc.) on a trunk group.
• sipRegFailPolicing - Specifies the current number of
SIP registration attempts that failed due to policing on a
trunk group.
2–49
TABLE 2–9
Parameter
Field
Length
callFailureInt N/A
ervalStatistic
s
2–50
show
Description
Specifies the trunk group current call failure statistics.
Options are:
• allocFailBwLimit - Specifies the number of bandwidth
Requests which fail because the configured bandwidth limit
has been exceeded for this trunk group for the specified
interval.
• allocFailCallLimit - Specifies the number of
bandwidth Requests which fail because configured call limit
has been exceeded for this trunk group for the specified
interval.
• callAbandoned - Specifies the current number of calls on
a trunk toll-free group that were abandoned while dialing for
the specified interval.
• callFailPolicing - Specifies the current number of calls
on a trunk group that failed due to policing for the specified
interval.
• inCallFailInvalidCall - Specifies the number of
inbound failed calls because there was an invalid call
attempt for this trunk group for the specified interval.
• inCallFailNetworkFailure - Specifies the number of
inbound failed calls because there was a network failure for
• inCallFailNoResources - Specifies the number of
inbound failed calls because there was an unavailable
resource for this trunk group for the specified interval.
• inCallFailNoRoutes - Specifies the number of inbound
failed calls because there was no route available for this
trunk group for the specified interval.
• inCallFailNoService - Specifies the number of inbound
failed calls because there was an unavailable service for this
trunk group for the specified interval.
• inCallFailProtocolError - Specifies the number of
inbound failed calls because there was a protocol error for
• inCallFailUnspecified - Specifies the number of
inbound failed calls for an unspecified reason for this trunk
• invalidSPCallsFailed - Specifies the current number of
calls that failed due to mismatched ingress signaling port
from CP according to RCB for the specified interval.
• noPsxRoute - Specifies the current number of calls on an
ingress trunk group that failed due to no routes returned from
the PSX for the specified interval.
show
TABLE 2–9
Parameter
Field
Length
callFailureInt N/A
ervalStatistic
s (continued)
Description
• nonMatchSrcIpCallsFail - Specifies the current number
of calls that failed due to mismatched source IP of IAD
according to its RCB for the specified interval.
• nonRegCallsFailed - Specifies the current number of
calls that failed due to registration requirement for SIP trunk
• outCallFailInvalidCall - Specifies the number of
outbound failed calls because there was an invalid call
attempt for this trunk group for the specified interval.
• outCallFailNetworkFailure - Specifies the number of
outbound failed calls because there was a network failure for
• outCallFailNoResources - Specifies the number of
resource for this trunk group for the specified interval.
• outCallFailNoRoutes - Specifies the number of
outbound failed calls because there was no route available
for this trunk group for the specified interval.
• outCallFailNoService - Specifies the number of
service for this trunk group for the specified interval.
• outCallFailProtocolError - Specifies the number of
outbound failed calls because there was a protocol error for
• outCallFailUnspecified - Specifies the number of
outbound failed calls for an unspecified reason for this trunk
• routingFailuresResv - Specifies the number of routing
failures due to no un-reserved circuits for this trunk group for
the specified interval.
• securityFail - Specifies the current number of calls that
failed due to a mismatch between the peer security and
route packet service profile security on a trunk group for the
specified interval.
• sipRegFailInternal - Specifies the current number SIP
registration attempts that failed due to other reasons
(signaling failures, etc.) on a trunk group for the specified
interval.
• sipRegFailOther - The current number SIP registration
attempts that failed due to other reasons (signaling failures,
etc.) on a trunk group for the specified interval.
• sipRegFailPolicing - Specifies the current number SIP
registration attempts that failed due to policing on a trunk
2–51
TABLE 2–9
Parameter
show
Field
Length
trunkGroupStat N/A
us
Description
Specifies the status for IP trunk groups in this zone.
Options are:
• bandwidthAvailable - Specifies the bandwidth available
for allocation.
• bandwidthCurrentLimit - Specifies the current
bandwidth limit for this IP trunk group.
• bwInboundUsage - Specifies the bandwidth is in use for
inbound traffic.
• bwOutboundUsage - Specifies the bandwidth is in use for
outbound traffic.
• callsAvailableTotal - Specifies the sum of all available
or unblocked calls for this trunk group.
• callsConfiguredTotal - This object reflects the total
number of calls that are configured on this IP trunk group.
• inboundCallsUsage - This is only meaningful for IP trunk
groups that are configured for inbound or both directions.
• outboundCallsUsage - This reflects the current outbound,
non-priority usage count of this IP trunk group.
• packetOutDetectState - This object indicates the packet
outage detection state.
• priorityCallUsage - This is only meaningful for IP trunk
groups that are configured with call reserved state enabled.
• state - Current operational state of the IP trunk group.
• totalCallsInboundReserved - This is meaningful for IP
trunk groups that are configured for inbound or both
directions only.
• totalOutboundCallsReserved - This is meaningful for
IP trunk groups that are configured for incoming call
reservation.
2–52
show
TABLE 2–9
Parameter
Field
Length
zoneStatus
N/A
Description
Specifies the current status for zones in this address
context. Options are:
• activeSipRegCount - Specifies the number of SIP
registrations active across all IP trunks in this zone.
• bandwidthAvailable - Specifies the available media
bandwidth across all IP trunks in this zone.
• bandwidthCurrentLimit - Specifies the current media
bandwidth limit across all IP trunks in this zone.
• bwInboundUsage - Specifies the current media bandwidth
in use for inbound traffic across all IP trunks in this zone.
• bwOutboundUsage - Specifies the current media bandwidth
in use for outbound traffic across all IP trunks in this zone.
• callsAvailableTotal - Specifies the sum of all
available or unblocked calls across all IP trunks in this zone.
• callsConfiguredTotal - Specifies the total number of
calls configured (allowed) across all IP trunks in this zone.
• emergencyCallsBwUsage - Specifies the current media
bandwidth in use for emergency calls across all IP trunks in
this zone.
• inboundCallsUsage - Specifies the current inbound
usage count across all IP trunks in this zone.
• outboundCallsUsage - Specifies the current outbound,
non-priority usage count across all IP trunks in this zone.
• priorityCallUsage - Specifies the current priority call
count across all IP trunks in this zone.
2–53
TABLE 2–9
show
Parameter
zoneCurrentSta
tistics
Field
Length
N/A
Description
Specifies the Zone Statistics Current table entries.
Options are:
• egressFailBWLimit - Specifies the number of outgoing
Calls failed due to bandwidth limit.
• egressFailCallLimit - Specifies the number of outgoing
Calls failed due to call limit.
• egressFailCallPolicing - Specifies the number of
outgoing Calls failed due to call rate.
• egressSipRegFailLimit - Specifies the number of
outgoing SIP Registrations failed due to registration limit.
• egressSipRegPolicing - Specifies the number of
outgoing SIP Registrations failed due to registration rate.
• ingressFailBWLimit - Specifies the number of incoming
• ingressFailCallLimit - Specifies the number of
incoming Calls failed due to call limit.
• ingressFailCallPolicing - Specifies the number of
incoming Calls failed due to call rate.
• ingressSipRegFailLimit - Specifies the number of
incoming SIP Registrations failed due to registrations limit
• ingressSipRegPolicing - Specifies the number of
incoming SIP Registrations failed due to registration rate.
2–54
show
TABLE 2–9
Parameter
zoneIntervalSt
atistics
Field
Length
N/A
Description
Specifies the Zone Statistics Interval table entries.
Options are:
• egressFailBWLimit - Specifies the number of outgoing
• egressFailCallLimit - Specifies the number of outgoing
Calls failed due to call limit.
• egressFailCallPolicing - Specifies the number of
outgoing Calls failed due to call rate.
• egressSipRegFailLimit - Specifies the number of
outgoing SIP Registrations failed due to registration limit.
• egressSipRegPolicing - Specifies the number of
outgoing SIP Registrations failed due to registration rate.
• ingressFailBWLimit - Specifies the number of incoming
• ingressFailCallLimit - Specifies the number of
incoming Calls failed due to call limit.
• ingressFailCallPolicing - Specifies the number of
incoming Calls failed due to call rate.
• ingressSipRegFailLimit - Specifies the number of
incoming SIP Registrations failed due to registration limit.
• ingressSipRegPolicing - Specifies the number of
incoming SIP Registrations failed due to registration rate.
Example
admin@server1> show status addressContext default
ipAccessControlList displaylevel 4
ipAclRuleStatistics RULE1 {
matches
0;
policerDiscards 0;
}
ipAclRuleStatistics rule1 {
matches
0;
policerDiscards 0;
}
ipAclOverallStatistics default {
matchedNoRule 0;
2–55
show
}
ipAclRulesByPrecedence 1 {
name
rule1;
matches
0;
policerDiscards 0;
}
ipAclRulesByPrecedence 4 {
name
RULE1;
matches
0;
policerDiscards 0;
}
[ok][2011-02-09 07:31:41]
To display the link detection group status:
show status addressContext default linkDetectionGroup
MGMT_LDG2 linkMonitorStatus MGMT_LM2
{
monitorStatus monitoring;
linkStatus up;
}
linkMonitorStatus MGMT_LM4
{
monitorStatus portDown;
linkStatus portDown;
}
linkMonitorStatistics MGMT_LM2
{
minTime 336;
maxTime 740;
averageTime 375;
singleFailures 0;
doubleFailures 0;
failures 0;
replies 13;
duplicateReplies 0;
lateReplies 0;
}
linkMonitorStatistics MGMT_LM4
{
2–56
show
minTime 0;
maxTime 0;
averageTime 0;
singleFailures 0;
doubleFailures 0;
failures 1;
replies 0;
duplicateReplies 0;
lateReplies 0;
}
Command Syntax
To display status of alarms:
> show status alarms currentStatus <currentStatus>
desc <desc>
reporter <reporter>
severity <severity>
timestamp <timestamp>
> show status alarms displaylevel <displaylevel>
> show status alarms historyStatus <historyStatus>
desc <desc>
reporter <reporter>
severity <severity>
state <state>
timestamp <timestamp>
> show status alarms historyStatus displaylevel
<displaylevel>
Command Parameters
TABLE 2–10 Alarms Parameters
Parameter
Field
Length
Description
currentStatus
N/A
Displays the Status table for current outstanding alarms.
desc
N/A
Specifies the description of the alarm.
displaylevel
1-64
commands.
reporter
N/A
Specifies the name of the task reporting this alarm.
severity
N/A
Specifies the severity of the alarm.
2–57
show
TABLE 2–10 Alarms Parameters (Continued)
Parameter
Field
Length
Description
timestamp
N/A
Specifies the time when the alarm was raised.
historyStatus
N/A
Specifies the status table for History-Alarms.
state
N/A
Specifies the state of the alarm. Options are:
• SET
• CLEAR
Example
To display current status of alarms with severity as Major:
admin@server1> show status alarms currentStatus severity
Major
currentStatus 2 {
timestamp 2011-02-09T01:02:11;
desc
"Node: sbx30 active after boot";
reporter
SM;
severity
Major;
}
currentStatus 3 {
timestamp 2011-02-09T01:02:11;
desc
"Server sbx30.eng.sonusnet.com, of System sbx30
is operational";
reporter
SM;
severity
Major;
}[ok][2011-02-09 07:04:06]
Command Syntax
To display status of global object:
> show status global displaylevel <displaylevel>
> show status global policyServer
CdDNBasedDestAllowedTable
CdDNBasedDestBlockedTable
contractorBasedOrigAllowedTable
contractorBasedOrigBlockedTable
dialedDestAllowedTable
dialedDestBlockedTable
displaylevel
dnsEnumCounters
2–58
show
failureCounters
finalCallingNumberAllowedTable
finalCallingNumberBlockedTable
finalDestAllowedTable
finalDestBlockedTable
hpcCallsPerGsxTable
hpcExemptionGsxTable
lnpGsxTable
lnpTfCounters
mwiServiceCounters
originationAllowedTable
originationBlockedTable
policyReqCounters
serviceUsageCounters
sipCounters
sipE911Counters
translatedDestAllowedTable
translatedDestBlockedTable
policyReqCounters
totalReqsNoExtSvc
totalTimeNoExtSvc
averageTimeNoExtSvc
totalRequestsExtSvc
totalTimeExtSvc
averageTimeExtSvc
extTime
averagExtTime
totalTimeouts
totalTimeTORequests
averageTimeTORequests
totalNonSsRequests
totalTimeNonSsRequests
averagTimeNonSsRequests
serviceUsageCounters
defaultSvcs
subsScreening
subsBlocking
nonSubsScreening
nonSubsBlocking
subsForcedRouting
subsHiFraudBlocking
subsSacNonSacRoutes
destNumForcedRouting
cicPhoneScreening
cicScreening
cicBlocking
cicForcedRouting
cicHiFraudBlocking
cicSacNonSacRoutes
tgScreening
tgBlocking
2–59
show
tgForcedRouting
tgHiFraudBlocking
tgSacNonSacRoutes
casualCallUnallowed
nonSubscriberCallsUnallowed
gwScreening
gwBlocking
gwForcedRouting
gwHiFraudBlocking
gwSacNonSacRoutes
authcodeScreening
authcodeBlocking
authcodeForcedRouting
authcodeHiFraudBlocking
authcodeSacNonSacRoutes
infodigitScreening
infodigitBlocking
infodigitForcedRouting
infodigitHiFraudBlocking
infodigitSacNonSacRoutes
softswitchScreening
softswitchBlocking
softswitchForcedRouting
softswitchHiFraudBlocking
softswitchSacNonSacRoutes
lnpTfCounters
numLNPRequests
numSCPRequests
numDNRequests
numTimedOutRequests
numRequestErrors
tfcNumRequests
tfcNumRequestsToScp
tfcNumRequestsTranslated
tfcNumTimedOutRequests
tfcNumRequestErrors
mwiServiceCounters
MWIService
MWIUpdateService
dnsEnumCounters
DNSRequestsSent
DNSResponsesReceived
ENUMRequestsSent
ENUMResponsesReceived
KARequestsSent
KAResponsesReceived
ENUMResponseSuccess
ENUMResponseGeneralFailure
ENUMResponseNoMemory
2–60
show
ENUMResponseInvalidParameter
ENUMResponseNoName
ENUMResponseNoData
DNSCanceledRequests
ENUMCanceledRequests
longTermAverageTransTime
shortTermAverageTransTime
NAPTRRscRecordReqSent
NAPTRRscRecordRspReceived
NAPTRRscRecordCanceledReq
NAPTRRscRecordRspSuccess
NAPTRRscRecordRspGeneralFailure
NAPTRRscRecordRspNoMemory
NAPTRResourceRecordRspInvalidParam
NAPTRResourceRecordRspNoName
NAPTRResourceRecordRspNoData
SRVResourceRecordRequestsSent
SRVResourceRecordResponsesReceived
SRVResourceRecordCanceledRequests
SRVResourceRecordRspSuccess
SRVResourceRecordRspGeneralFailure
SRVResourceRecordRspNoMemory
SRVResourceRecordRspInvalidParam
SRVResourceRecordRspNoName
SRVResourceRecordRspNoData
AResourceRecordRequestsSent
AResourceRecordResponsesReceived
AResourceRecordCanceledRequests
AResourceRecordRspSuccess
AResourceRecordRspHostNotFound
AResourceRecordRspTryAgain
AResourceRecordRspNoRecovery
AResourceRecordRspNoData
LNPRequestsSent
CNAMRequestsSent
failureCounters
numQueryError
numInternalError
numExternalError
lnpGsxTable <ipaddress>
gsxName <gsxName>
gsxMisroutedCalls
gsxInvalidNumbers
sipE911Counters
reqSent
totalRspRcvd
successfulRspRcvd
failedRspRcvd
reqRetry
2–61
show
sipCounters
sipInviteSent
sip2xxRcvd
sip3xxRcvd
sip4xxRcvd
sip5xxRcvd
sip6xxRcvd
> show status global callCountStatus all
> show status global callDetailStatus callDuration
<callDuration>
> show status global callSummaryStatus
callIndex
calledNumber
callingNumber
state
> show status global callSummaryStatus state <state>
> show status global callSummaryStatus displaylevel
<displaylevel>
> show status global callCountStatus
callAttempts
callCompletions
activeCalls
stableCalls
callUpdates
activeCallsNonUser
stableCallsNonUser
totalCalls
totalCallsNonUser
totalCallsEmergEstablishing
totalCallsEmergStable
> show status global
inReceives
inHdrErrors
inAddrErrors
inUnknownProtos
inDiscards
inDelivers
outRequests
outDiscards
outNoRoutes
reasmTimeout
reasmReqds
reasmOKs
reasmFails
fragOKs
fragFails
2–62
ipGeneralGroupStatistics
show
> show status global icmpGeneralGroupStatistics
inMsgs
inEchos
inEchoReps
inDestUnreachs
inErrors
outMsgs
outErrors
outEchos
outEchoReps
outDestUnreachs
> show status global tcpGeneralGroupStatistics
establishedConnections
clientConnections
serverConnections
failedAttempts
inSegments
outSegments
retransSegments
inErrors
inResets
outResets
> show status global udpGeneralGroupStatistics
inDatagrams
outDatagrams
unknownPorts
inErrors
show status global globalTrunkGroupStatus
addressContext
bwAvailable
bwCurrentLimit
bwInboundUsage
bwOutboundUsage
displaylevel
inboundCallsUsage
outboundCallsUsage
packetOutDetectState
priorityCallUsage
state
totalCallsAvailable
totalCallsConfigured
totalCallsInboundReserved
totalOutboundCallsReserved
zone
2–63
show
Command Parameters
TABLE 2–11 Global Parameters
Parameter
Field
Length
displaylevel
1-64
commands.
policyServer
N/A
Specifies the policy server statistics. Options are:
Description
• CdDNBasedDestAllowedTable - Specifies the Traffic
Management related counters for allowed called DN based
destination.
• CdDNBasedDestBlockedTable - Specifies the Traffic
Management related counters for blocked called DN based
destination.
2–64
show
TABLE 2–11 Global Parameters (Continued)
Parameter
policyServer
(continued)
Field
Length
N/A
Description
• contractorBasedOrigAllowedTable - Specifies the
Traffic Management related counters for allowed contractor
number based origination.
• contractorBasedOrigBlockedTable - Specifies the
Traffic Management related counters for blocked contractor
number based origination.
• dialedDestAllowedTable - Specifies the Traffic
Management related counters for allowed dialed destination
number.
• dialedDestBlockedTable - Specifies the Traffic
Management related counters for blocked dialed destination
number.
• dnsEnumCounters - Specifies the Policy DNS ENUM
query counters.
• failureCounters - Specifies the Policy failure counters.
• finalCallingNumberAllowedTable - Specifies the
Traffic Management related counters for allowed final calling
number.
• finalCallingNumberBlockedTable - Specifies the
Traffic Management related counters for blocked final calling
number.
• finalDestAllowedTable - Specifies the Traffic
Management related counters for allowed final destination
number.
• finalDestBlockedTable - Specifies the Traffic
Management related counters for blocked final destination
number.
• hpcCallsPerGsxTable - Specifies the Ingress PSTN HPC
Calls related counters per SBC 5x00 table.
• hpcExemptionGsxTable - Specifies the Traffic
Management HPC Exemption related counters per SBC
5x00 table.
• InpGsxTable - Specifies the LNP related counters per SBC
5x00 table.
• InpTfCounters - Specifies thePolicy LNP and toll-free
counters.
2–65
show
Parameter
policyServer
(continued)
2–66
Field
Length
N/A
Description
• mwiServiceCounters - Specifies the Policy Message
Waiting Indicator service counters.
• originationAllowedTable - Specifies the number of
calls for which a origination number with a provisioned Traffic
control was allowed to complete.
• originationBlockedTable - Specifies the number of
calls for which a origination number with a provisioned Traffic
control was blocked.
• serviceUsageCounters - Specifies the Policy service
usage counters.
• sipCounters - Specifies the Policy SIP message counters.
• sipE911Counters - Specifies the Policy E911 service
counters.
• translatedDestAllowedTable - Specifies the Traffic
Management related counters for allowed translated
destination number.
• translatedDestBlockedTable - Specifies the Traffic
Management related counters for blocked translated
destination number.
• policyReqCounters - Specifies the Policy request
counters.
show
Parameter
Field
Length
policyReqCount N/A
ers
Description
Displays the policy request counters. Options are:
• averagExtTime - Specifies the average time (in
milliseconds) that it took in the external service to process
each request.
• averagTimeNonSsRequests - Specifies the average time
in milliseconds it took to process each of these non-policy
requests.
• averagTimeExtSvc - Specifies the average time (in
milliseconds) it took to process each of these requests.
• averagTimeNoExtSvc - Specifies the average amount of
time (in milliseconds) taken to process each individual
request.
• averagTimeToRequests - Specifies the average time
taken to process each timed out request.
• extTime - Specifies the total time (in milliseconds) it took in
the external service to process all of these requests.
• totalNonSsRequests - Specifies the total number of nonpolicy requests.
• totalReqsNoExtSvc - Specifies the total number of policy
requests (excluding those that needed external services,
such as an SCP lookup) which were handled by the Soft
Switch.
• totalRequestsExtSvc - Specifies the total requests
(External Svc): The number of requests which used an
external service.
• totalTimeExtSvc - Specifies the total time (in
milliseconds) it took to process the requests that required an
external service.
• totalTimeNoExtSvc - Specifies the total time (number of
milliseconds) taken to process these requests.
• totalTimeNoSsRequests - Specifies the total time (in
milliseconds) it took to process these non-policy requests.
• totalTimeTORequests - Specifies the total time (in
milliseconds) taken to process the timed out requests in the
Softswitch.
• totalTimeouts - Specifies the total number of external
service requests which timed out.
2–67
show
Parameter
serviceUsageCo
unters
2–68
Field
Length
Description
N/A
Specifies the policy service usage counters. Options are:
• authcodeBlocking - Specifies the counter that keeps
track of how many times the Authcode Blocking service is
executed.
• authcodeForcedRouting - Specifies the counter that
keeps track of how many times the Authcode Forced
Routing service is executed.
• authcodeHiFraudBlocking - Specifies the counter that
keeps track of how many times the Authcode HiFraud
Blocking service is executed.
• authcodeSacNonSacRoutes - Specifies the counter that
keeps track of how many times the Authcode SAC/Non-SAC
Routing service is executed.
• authcodeScreening - Specifies the counter that keeps
track of how many times the Authcode Screening Service is
executed.
• casualCallUnallowed - Casual calls are not allowed:
Specifies the counter that keeps track of how many times
casual calls are not allowed through the network.
• cicBlocking - Specifies the counter that keeps track of
how many times CIC Blocking Service is executed.
• cicForcedRouting - CIC Forced Routing: Specifies the
counter that keeps track of how many times CIC Forced
Routing Service is executed.
• cicHiFraudBlocking - CIC HiFraud Blocking: Specifies
the counter that keeps track of how many times CIC HiFraud
Blocking Service is executed.
• cicPhoneScreening - CIC Phone Screening: Specifies
the counter that keeps track of how many times incoming
phone type calls are not allowed.
• cicSacNonSacRoutes - CIC SAC/Non-SAC Routes:
CIC SAC/Non-SAC Routing Service is executed.
• cicScreening - CIC Screening: Specifies the counter that
keeps track of how many times CIC Screening Service is
executed.
• defaultSvcs - Default Service: Specifies the counter that
keeps track of how many times default service is executed.
• destNumForcedRouting - Destination Number Forced
Routing: Specifies the counter that keeps track of how many
times Destination Number Forced Routing Service is
executed.
show
Parameter
serviceUsageCo
unters
(continued)
Field
Length
N/A
Description
• gwBlocking - Gateway Blocking: Specifies the counter
that keeps track of how many times Gateway Blocking
Service is executed.
• gwForcedRouting - Gateway Forced Routing: Specifies
the counter that keeps track of how many times Gateway
Forced Routing Service is executed.
• gwHiFraudBlocking - Gateway HiFraud Blocking:
Gateway HiFraud Blocking Service is executed.
• gwSacNonSacRoutes - Gateway SAC/Non-SAC Routes:
Gateway SAC/Non-SAC Routing Service is executed.
• gwScreening - Gateway Screening: Specifies the counter
that keeps track of how many times Gateway Screening
• infodigitBlocking - Infodigit Blocking: Specifies the
counter that keeps track of how many times the Infodigit
• infodigitForcedRouting - Infodigit Forced Routing:
Specifies the counter that keeps track of how many times the
Infodigit Forced Routing service is executed.
• infodigitHiFraudBlocking - Infodigit HiFraud
Blocking: Specifies the counter that keeps track of how many
times the Infodigit HiFraud Blocking service is executed.
• infodigitSacNonSacRoutes - Infodigit SAC/Non-SAC
Routes: Specifies the counter that keeps track of how many
times the Infodigit SAC/Non-SAC Routing service is
executed.
• infodigitScreening - Infodigit Screening: Specifies the
counter that keeps track of how many times the Infodigit
Screening Service is executed.
• nonSubsBlocking - Non Subscriber Blocking: Specifies
the counter that keeps track of how many times Subscriber
Blocking Service is executed.
• nonSubsScreening - Non Subscriber Screening: Specifies
the counter that keeps track of how many times Non
Subscriber Screening Service is executed.
• nonSubscriberCallsUnallowed - Non Subscriber calls
not allowed: Specifies the counter that keeps track of how
many times non subscriber calls are not allowed through the
network.
• softswitchBlocking - Softswitch Blocking: Specifies the
counter that keeps track of how many times the SoftSwitch
2–69
show
Parameter
serviceUsageCo
unters
(continued)
2–70
Field
Length
N/A
Description
• softswitchForcedRouting - Softswitch Forced Routing:
Specifies the counter that keeps track of how many times the
SoftSwitch Forced Routing service is executed.
• softswitchHiFraudBlocking - Softswitch HiFraud
Blocking: Specifies the counter that keeps track of how many
times the SoftSwitch HiFraud Blocking service is executed.
• softswitchSacNonSacRoutes - Softswitch SAC/NonSAC Routes: Specifies the counter that keeps track of how
many times the SoftSwitch SAC/Non-SAC Routing service is
executed.
• softswitchScreening - Softswitch Screening: Specifies
the counter that keeps track of how many times the
SoftSwitch Screening Service is executed.
• subsBlocking - Subscriber Blocking: Specifies the counter
that keeps track of how many times Subscriber Blocking
• subsForcedRouting - Subscriber Forced Routing:
Subscriber Forced Routing Service is executed.
• subsHiFraudBlocking - Subscriber HiFraud Blocking:
Subscriber HiFraud Blocking Service is executed.
• subsSacNonSacRoutes - Subscriber SAC/Non-SAC
Routes: Specifies the counter that keeps track of how many
times Subscriber SAC/Non-SAC Routing Service is
executed.
• subsScreening - Subscriber Screening: Specifies the
counter that keeps track of how many times Subscriber
• tgBlocking - Trunkgroup Blocking: Specifies the counter
that keeps track of how many times Trunkgroup Blocking
• tgForcedRouting - Trunkgroup Forced Routing:
Specifies the counter keeps track of how many times
Trunkgroup Forced Routing Service is executed.
• tgHiFraudBlocking - Trunkgroup HiFraud Blocking:
Trunkgroup HiFraud Blocking Service is executed.
• tgSacNonSacRoutes - Trunkgroup SAC/Non-SAC Routes:
Trunkgroup SAC/Non-SAC Routing Service is executed.
• tgScreening - Trunkgroup Screening: Specifies the
counter that keeps track of how many times Trunkgroup
show
Parameter
Field
Length
lnpTfCounters
N/A
Description
Specifies the policy LNP and toll-free counters. Options
are:
• numDNRequests - Number of LNP requests to ported DN's:
Specifies the number of LNP requests made for ported DN's.
• numLNPRequests - Number of requests that need LNP:
Specifies the total number of requests received by the Sonus
SoftSwitch which require LNP translation.
• numRequestErrors - Number of LNP request Errors:
Specifies the number of errors other than timeout received
from the SCP.
• numSCPRequests - Number of LNP requests sent to SCP:
Specifies the total number of requests sent to the SCP for
LNP translation.
• numTimedOutRequests - Number of timed out LNP
requests: Specifies the number of LNP requests that timed
out.
• tfcNumRequestErrors - Number of toll-free request
Errors: Specifies the number of toll-free requests that
resulted in an error.
• tfcNumRequests - Number of requests that need toll-free
translation: Specifies the total number of requests received
by the Sonus SoftSwitch which require toll-free translation.
• tfcNumRequestsToScp - Number of toll-free requests sent
to SCP: Specifies the total number of requests sent to the
SCP for translation.
• tfcNumRequestsTranslated - Number of toll-free
requests translated: Specifies the number of toll-free
requests that were successfully translated.
• tfcNumTimedOutRequests - Number of timed out toll-free
requests: Specifies the number of toll-free requests that
timed out.
mwiServiceCoun
ters
N/A
Specifies the policy message waiting indicator service
counters. Options are:
• MWIService - This counter keeps track of calls that execute
MWI service.
• MWIUpdateService - This counter keeps track of calls that
execute MWI Status Update service.
2–71
show
Parameter
dnsEnumCounter
s
Field
Length
N/A
Description
Specifies the policy DNS ENUM query counters. Options
are:
• AResourceRecordCanceledRequests - Specifies the
number of DNS A Resource Record requests canceled by
PSX.
• AResourceRecordRequestsSent - Specifies the number
of DNS A Resource Record requests sent by PSX.
• AResourceRecordResponsesReceived - Specifies the
number of DNS A Resource Record responses received by
PSX.
• AResourceRecordRspHostNotFound - Specifies the
number of DNS A Resource Record Responses with
Host_Not_Found Failure.
• AResourceRecordRspNoData - Specifies the number of
DNS A Resource Record Responses with
Valid_Name_But_No_Data_Record Failure.
• AResourceRecordRspNoRecovery - Specifies the
number of DNS A Resource Record Responses with
Non_Recoverable_Name_Server_Error Failure.
• AResourceRecordRspSuccess - Specifies the number of
Successful DNS A Resource Record Responses.
• AResourceRecordRspTryAgain - Specifies the number
of DNS A Resource Record Responses with
Temporary_Server_Error_Try_Again Failure.
• CNAMRequestsSent - Specifies the total number of ENUM
requests sent for CNAM by PSX.
• DNSCanceledRequests - Specifies the total number of
DNS requests canceled by PSX.
• DNSRequestsSent - Specifies the total number of DNS
requests sent by PSX.
• DNSResponsesReceived - Specifies the total number of
DNS responses received by PSX.
• ENUMCanceledRequests - Specifies the total number of
ENUM requests canceled by PSX.
• ENUMRequestsSent - Specifies the total number of ENUM
requests sent for SIP AoR by PSX.
• ENUMResponseGeneralFailure - Specifies the total
number of ENUM responses with General Failure.
• ENUMResponseInvalidParameter - Specifies the total
number of ENUM responses with Invalid_Parameter Failure.
• ENUMResponseNoData - Specifies the total number of
ENUM responses with Valid_Name_But_No_Data_Record
Failure.
• ENUMResponseNoMemory - Specifies the total number of
ENUM responses with Memory_Unavailable Failure.
2–72
show
Parameter
dnsEnumCounter
s (continued)
Field
Length
N/A
Description
• ENUMResponseNoName - Specifies the total number of
ENUM responses with Name_Does_Not_Exist Failure.
• ENUMResponseSuccess - Specifies the total number of
Successful ENUM responses.
• ENUMResponsesReceived - Specifies the total number of
ENUM responses received by PSX.
• KARequestsSent - Specifies the total number of KeepAlive
requests sent by PES.
• KAResponsesReceived - Specifies the total number of
KeepAlive responses received by PSX.
• LNPRequestsSent - Specifies the total number of ENUM
requests sent for LNP by PSX.
• NAPTRResourceRecordRspInvalidParam - Specifies
the number of DNS NAPTR Resource Record responses
with Invalid_Parameter Failure.
• NAPTRResourceRecordRspNoData - Specifies the
number of DNS NAPTR Resource Record responses with
• NAPTRResourceRecordRspNoName - Specifies the
Name_Does_Not_Exist Failure.
• NAPTRRscRecordCanceledReq - Specifies the number of
DNS NAPTR Resource Record requests canceled by PSX.
• NAPTRRscRecordReqSent - Specifies the number of DNS
NAPTR Resource Record requests sent by PSX.
• NAPTRRscRecordRspGeneralFailure - Specifies the
General Failure.
• NAPTRRscRecordRspNoMemory - Specifies the number of
DNS NAPTR Resource Record responses with
Memory_Unavailable Failure.
• NAPTRRscRecordRspReceived - Specifies the number of
DNS NAPTR Resource Record responses received by PSX.
• NAPTRRscRecordRspSuccess - Specifies the number of
Successful DNS NAPTR Resource Record responses.
• SRVResourceRecordCanceledRequests - Specifies the
number of DNS SRV Resource Record requests canceled
by PSX.
• SRVResourceRecordRequestsSent - Specifies the
number of DNS SRV Resource Record requests sent by
PSX.
• SRVResourceRecordResponsesReceived - Specifies
the number of DNS SRV Resource Record responses
received by PSX.
2–73
show
Parameter
Field
Length
Description
dnsEnumCounter
s (continued)
N/A
• SRVResourceRecordRspGeneralFailure - Specifies
the number of DNS SRV Resource Record responses with
General Failure.
• SRVResourceRecordRspInvalidParam - Specifies the
number of DNS SRV Resource Record responses with
Invalid_Parameter Failure.
• SRVResourceRecordRspNoData - Specifies the number
of DNS SRV Resource Record responses with
• SRVResourceRecordRspNoMemory - Specifies the
number of DNS SRV Resource Record responses with
Memory_Unavailable Failure.
• SRVResourceRecordRspNoName - Specifies the number
of DNS SRV Resource Record responses with
Name_Does_Not_Exist Failure.
• SRVResourceRecordRspSuccess - Specifies the number
of Successful DNS SRV Resource Record responses.
• longTermAverageTransTime - Specifies the long term
average of transaction time.
• shortTermAverageTransTime - Specifies the short term
average of transaction time.
failureCounter
s
N/A
Specifies the policy failure counters. Options are:
ipaddress
N/A
• numExternalError - Specifies the number of requests
that encountered an External Error.
• numInternalError - Specifies the number of requests
that encountered an Internal Error.
• numQueryError - Specifies the number of requests that
encountered an SQL Query Error.
Specifies the SBC 5x00 IP Address that the LNP
Counters apply to. Options are:
• gsxInvalidNumbers - Invalid Number: Specifies the
number of LNP-specific ISUP release messages received by
the SBC 5x00 with cause 28 - Invalid number format.
• gsxMisroutedCalls - Misrouted calls: Specifies the
number of LNP-specific ISUP release messages received by
the SBC 5x00 with cause 26 - misrouted call to a ported
number.
• gsxName - Specifies the SBC 5x00 name that the LNP
Counters apply to.
2–74
show
Field
Length
Description
sipE911Counter
s
N/A
Specifies the policy E911 service counters. Options are:
sipCounters
N/A
Parameter
• failedRspRcvd - Specifies the counter that keeps track of
the number of failed Emergency Services Routing
Responses (ESRRsp) which have been received by the
PSX.
• reqRetry - Specifies the counter that keeps track of the
number of Emergency Services Routing Requests
(ESRReq) which have been retransmitted by the PSX.
• reqSent - Specifies the counter that keeps track of the
number of Emergency Services Routing Requests
(ESRReq) which have been sent by the PSX.
• successfulRspRcvd - Specifies the counter that keeps
track of the number of successful Emergency Services
Routing Responses (ESRRsp) which have been received by
the PSX.
• totalRspRcvd - Specifies the counter that keeps track of
the total number of Emergency Services Routing Responses
(ESRRsp) which have been received by the PSX.
Specifies the policy SIP message counters. Options are:
• sip2xxRcvd - Specifies the counter that keeps track of the
number of 2XX responses which have been received by
SCPA process.
SCPA process for INVITE transactions.
• sipInviteSent - Specifies the counter that keeps track of
the number of INVITE requests which have been sent by
SCPA process.
callCountStatu N/A
s
callDetailStat
us
N/A
Displays the call count statistics for the server..
Displays the call detail status table.
• callDuration - Specifies the duration (in seconds) for this
call following answer.
2–75
show
Field
Length
Description
callSummarySta
tus
N/A
Specifies the call summary status table. Options are:
callCountStatu
s
N/A
Parameter
• callIndex - Specifies the target call index.
• calledNumber - Specifies the called Party's E.164
telephone number.
• callingNumber - Specifies the calling Party's E.164
telephone number.
• state - Specifies the current state of the call.
Specifies the call count statistics for the server. Options
are:
• activeCalls - Specifies the current number of active
managed calls on this server.
• activeCallsNonUser - Specifies the current number of
active non-call associated signalling channels in the server.
• callAttempts - Specifies the number of call attempts on
this server.
• callCompletions - Specifies the total number of
completed call attempts on this server.
• callUpdates - Specifies the number of call updates
(modifications) on this server.
• stableCalls - Specifies the current number of stable
managed calls on this server.
• stableCallsNonUser - Specifies the current number of
stable non-call associated signalling channels in the server.
• totalCalls - Specifies the total number of calls on this
server.
• totalCallsEmergEstablishing - Specifies the number
of establishing emergency calls.
• totalCallsEmergStable - Specifies the number of
stable emergency calls.
• totalCallsNonUser - Specifies the total number of nonuser calls on this server.
2–76
show
Parameter
ipGeneralGroup
Statistics
Field
Length
N/A
Description
Specifies the collection of IP General Group information
for the specified instance. Options are:
• fragFails - Specifies the number of IP datagrams that
have been discarded because they needed to be
fragmented at this entity but could not be, e.g., because their
Don't Fragment flag was set.
• fragOKs - Specifies the number of IP datagrams that have
been successfully fragmented at this entity.
• inAddrErrors - Specifies the number of input datagrams
discarded because the IP address in their IP header's
destination field was not a valid address to be received at
this entity.
• inDelivers - Specifies the total number of input
datagrams successfully delivered to IP user-protocols
(including ICMP).
• inDiscards - Specifies the number of input IP datagrams
for which no problems were encountered to prevent their
continued processing, but which were discarded (example,
for lack of buffer space).
• inHdrErrors - Specifies the number of input datagrams
discarded due to errors in their IP headers, including bad
checksums, version number mismatch, other format errors,
time-to-live exceeded, errors discovered in processing their
IP options.
• inReceives - Specifies the total number of input
datagrams received from interfaces, including those
received in error.
• inUnknownProtos - Specifies the number of locallyaddressed datagrams received successfully but discarded
because of an unknown or unsupported protocol.
• outDiscards - Specifies the number of output IP
datagrams for which no problem was encountered to prevent
their transmission to their destination, but which were
discarded (example, for lack of buffer space).
• outNoRoutes - Specifies the number of IP datagrams
discarded because no route could be found to transmit them
to their destination.
• outRequests - Specifies the total number of IP datagrams
which local IP user- protocols (including ICMP) supplied to
IP in requests for transmission.
• reasmFails - Specifies the number of failures detected by
the IP re-assembly algorithm (for whatever reason: timed out
and errors).
2–77
show
Parameter
Field
Length
Description
ipGeneralGroup
Statistics
(continued)
N/A
• reasmOKs - Specifies the number of IP datagrams
successfully re-assembled.
• reasmReqds - Specifies the number of IP fragments
received which needed to be reassembled at this entity.
• reasmTimeout - Specifies the maximum number of
seconds which received fragments are held while they are
awaiting reassembly at this entity.
icmpGeneralGro
upStatistics
N/A
Specifies the collection of ICMP General Group
information for the specified instance.
• inDestUnreachs - Specifies the number of ICMP
Destination Unreachable messages received.
• inEchoReps - Specifies the number of ICMP Echo Reply
messages received.
• inEchos - Specifies the number of ICMP Echo (request)
messages received.
• inErrors - Specifies the number of ICMP messages which
the entity received but determined as having ICMP-specific
errors (bad ICMP checksums, bad length).
• inMsgs - Specifies the total number of ICMP messages
which the entity received.
• outDestUnreachs - Specifies the number of ICMP
Destination Unreachable messages sent.
• outEchoReps - Specifies the number of ICMP Echo Reply
messages sent.
• outEchos - Specifies the number of ICMP Echo (request)
messages sent.
• outErrors - Specifies the number of ICMP messages
which this entity did not send due to problems discovered
within ICMP such as a lack of buffers.
• outMsgs - Specifies the total number of ICMP messages
which this entity attempted to send.
2–78
show
Parameter
tcpGeneralGrou
pStatistics
Field
Length
N/A
Description
Specifies the collection of TCP general group information
• clientConnections - Specifies the number of times TCP
connections have made a direct transition to the SYN-SENT
state from the CLOSED state.
• establishedConnections - Specifies the number of TCP
connections for which the current state is either
ESTABLISHED or CLOSE- WAIT.
• failedAttempts - Specifies the number of times TCP
connections have made a direct transition to the CLOSED
state from either the SYN-SENT state or the SYN-RCVD
state, plus the number of times TCP connections have made
a direct transition to the LISTEN state from the SYN-RCVD
state.
• inErrors - Specifies the total number of segments
received in error (example, bad TCP checksums).
• inResets - Specifies the number of times TCP connections
have made a direct transition to the CLOSED state from
either the ESTABLISHED state or the CLOSE-WAIT state.
• inSegments - Specifies the total number of segments
received, including those received in error.
• outResets - Specifies the number of TCP segments sent
containing the RST flag.
• outSegments - Specifies the total number of segments
sent, including those on current connections but excluding
those containing only retransmitted octets.
• retransSegments - Specifies the total number of
segments retransmitted - that is, the number of TCP
segments transmitted containing one or more previously
transmitted octets.
• serverConnections - Specifies the number of times TCP
connections have made a direct transition to the SYN-RCVD
state from the LISTEN state.
udpGeneralGrou
pStatistics
N/A
Specifies the collection of UDP general group information
• inDatagrams - Specifies the total number of UDP
datagrams delivered to UDP users.
• inErrors - Specifies the number of received UDP
datagrams that could not be delivered for reasons other than
the lack of an application at the destination port.
• outDatagrams - Specifies the total number of UDP
datagrams sent from this entity.
• unknownPorts - Specifies the total number of received
UDP datagrams for which there was no application at the
destination port.
2–79
show
Parameter
Field
Length
Description
globalTrunkGro N/A
upStatus
Specifies the status for IP trunk groups in this zone.
addressContext N/A
The name of address context for this trunk group.
NOTE
The characters #%^&(){}<>,/
\;`[]=!$'*?|~ and SPACE are not
allowed.
bwAvailable
0-64
This is how much bandwidth is available for allocation.
bwCurrentLimit N/A
This is the current bandwidth limit for this IP trunk group.
bwInboundUsage N/A
This is how much bandwidth is in use for inbound traffic.
bwOutboundUsag N/A
e
This is how much bandwidth is in use for outbound traffic.
inboundCallsUs N/A
age
This is only meaningful for IP trunk groups that are
configured for inbound or both directions.
outboundCallsU N/A
sage
This reflects the current outbound, non-priority usage
count of this IP trunk group.
packetOutDetec N/A
tState
This object indicates the packet outage detection state.
The available options are:
• normal
• packetOutageState
priorityCallUs N/A
age
state
N/A
This is only meaningful for IP trunk groups that are
configured with call reserved state enabled.
Current operational state of the IP trunk group.
• inService
• oosPending
• outOfService
totalOutboundC N/A
allsReserved
This is meaningful for IP trunk groups that are configured
for incoming call reservation.
totalCallsInbo N/A
undReserved
This is meaningful for IP trunk groups that are configured
for inbound or both directions only.
totalCallsConf N/A
igured
This object reflects the total number of calls that are
configured on this IP trunk group.
2–80
show
Parameter
Field
Length
totalCallsAvai N/A
lable
N/A
zone
Description
The sum of all available or unblocked calls for this trunk
group.
The name of zone for this trunk group.
NOTE
The characters #%^&(){}<>,/
\;`[]=!$'*?|~ and SPACE are not
allowed.
Example
To view the call count statistics:
admin@server1> show status global callCountStatus all
callAttempts
1;
callCompletions
1;
activeCalls
0;
stableCalls
0;
callUpdates
2;
activeCallsNonUser
0;
stableCallsNonUser
0;
totalCalls
0;
totalCallsNonUser
0;
totalCallsEmergEstablishing 0;
totalCallsEmergStable
0;
[ok][2011-02-09 06:56:49]
To view the status for IP trunk groups in this zone:
admin@server1> show status global globalTrunkGroupStatus
globalTrunkGroupStatus RHEL_1 {
state inService;
totalCallsAvailable -1;
totalCallsInboundReserved 0;
inboundCallsUsage 0;
outboundCallsUsage 0;
totalCallsConfigured -1;
priorityCallUsage 0;
2–81
show
totalOutboundCallsReserved 0;
bwCurrentLimit -1;
bwAvailable -1;
bwInboundUsage 0;
bwOutboundUsage 0;
packetOutDetectState normal;
addressContext a1;
zone ZONE1;
}
globalTrunkGroupStatus RHEL_2 {
state inService;
totalCallsAvailable -1;
totalCallsInboundReserved 0;
inboundCallsUsage 0;
outboundCallsUsage 0;
totalCallsConfigured -1;
priorityCallUsage 0;
totalOutboundCallsReserved 0;
bwCurrentLimit -1;
bwAvailable -1;
bwInboundUsage 0;
bwOutboundUsage 0;
packetOutDetectState normal;
addressContext a1;
zone ZONE2;
}
Command Syntax
To display status of oam objects:
> show status oam accounting displaylevel <displaylevel>
> show status oam accounting cdrServer status
state
progress
successfulTransfers
failedTransfers
pendingTransfers
> show status oam accounting radius radiusServerStatus
errorRate
rejectedRequests
2–82
show
requestRate
responsesWithAttributes
serverStatus
spuriousResponses
timedOutRequests
totalRequests
> show status oam eventLog
typeStatus
currentFile
fileRecords
fileBytes
totalFiles
totalFileBytes
memoryRecords
memoryBytes
filesDropped
memoryDropped
nextRollover
logDestination
lastFileDrop
lastMemoryDrop
> show status oam eventLog memoryStatus system <text>
> show status oam eventLog filterStatus <systemname>
eventsFiltered
> show status oam snmp community engineId
> show status oam alarms ipPolicingAlarmStatus
badEthernetIpHeaderAlarmLevel
<majorAlarm|minorAlarm|noAlarm>
badEthernetIpHeaderAlarmDuration
badEthernetIpHeaderDiscardRate
badEthernetIpHeaderPacketsDiscarded
arpAlarmLevel
arpAlarmDuration
arpDiscardRate
arpPacketsDiscarded
arpPacketsAccepted
uFlowAlarmLevel
uFlowAlarmDuration
uFlowDiscardRate
uFlowPacketsDiscarded
uFlowPacketsAccepted
aclAlarmLevel
aclAlarmDuration
aclDiscardRate
aclPacketsDiscarded
aclPacketsAccepted
aggregateAlarmLevel
aggregateAlarmDuration
aggregateDiscardRate
aggregatePacketsDiscarded
aggregatePacketsAccepted
ipSecDecryptAlarmLevel
2–83
show
ipSecDecryptAlarmDuration
ipSecDecryptDiscardRate
ipSecDecryptPacketsDiscarded
mediaAlarmLevel
mediaAlarmDuration
mediaDiscardRate
mediaPacketsDiscarded
rogueMediaAlarmLevel
rogueMediaAlarmDuration
rogueMediaDiscardRate
rogueMediaPacketsDiscarded
discardRuleAlarmLevel
discardRuleAlarmDuration
discardRuleDiscardRate
discardRulePacketsDiscarded
Command Parameters
TABLE 2–12 OAM Parameters
Parameter
Field
Length
displaylevel
1-64
commands.
cdrServer
N/A
Specifies the configuration for external CDR servers.
status
N/A
Specifies the status of the CDR server. Options are:
Description
• failedTransfers - Count of the number of failed
transfers.
• pendingTransfers - Count the number of pending
transfers.
• progress - Specifies that a transfer is in progress.
• state - Specifies the type of the event log.
• successfulTransfers - Count of the number of files
successfully transferred.
radius
2–84
N/A
Specifies the configuration for external Radius servers.
show
TABLE 2–12 OAM Parameters (Continued)
Field
Length
Description
radiusServerSt
atus
N/A
Specifies the status of the Radius server. Options are:
eventLog
N/A
Parameter
• errorRate - Specifies the percentage of requests that were
retried atleast once due to a timeout.
• rejectedRequests - Specifies the number of requests
that were not responded to by the server and presumed to
have been rejected.
• requestRate - Specifies the average number of requests
per second to the server.
• responsesWithAttributes - Specifies the number of
responses containing attributes.
• serverStatus - Specifies the operational state of the
server.
• spuriousResponses - Specifies the number of responses
without a corresponding request.
• timedOutRequests - Specifies the number of requests
that resulted in a timeout.
• totalRequests - Specifies the number of requests that
have been made to the server.
Specifies the Event log management.
2–85
show
Parameter
Field
Length
typeStatus
N/A
Description
Specifies the event log status table for status items
related to each Event Log type. Options are:
• currentFile - Specifies the filename that is currently
being used for logging.
• fileBytes - Count of the number of bytes written to the
current event log file.
• fileRecords - Count of the number of event records
written to the current event log file.
• filesDropped - Count of the number of event records
dropped when writing to an Event Log file.
• lastFilesDrop - Specifies the time of the last event
record dropped when writing to an Event Log file.
• lastMemoryDrop - Specifies the time of the last event
record dropped when writing to an Event Log memory buffer.
• logDestination - Identifies the location where this Event
Log type writes to.
• memoryBytes - Count of the number of bytes written to the
event log memory buffer.
• memoryDropped - Count of the number of event records
dropped when writing to an Event Log memory buffer.
• memoryRecords - Count of the number of event records
written to the event log memory buffer.
• nextRollover - Specifies the time in minutes left before
next rollover.
• totalFileBytes - Count of the number of bytes written to
the log files of this event type.
• totalFiles - Count of the number of log files of this event
type.
memoryStatus
N/A
Specifies the events logged to memory.
system
N/A
Specifies the index for the entry.
filterStatus
N/A
Specifies the Event Log Class Filter status table per card.
Options are:
• eventsFiltered - Specifies the number of events that
were filtered.
systemname
N/A
The event class to which the filter entry applies.
snmp
N/A
Specifies the SNMP configuration. Options are:
• community - This table contains SNMP community
information.
- engineId - Specifies the SNMP community context
engine ID.
2–86
show
Parameter
Field
Length
alarms
N/A
Description
Specifies the alarm configuration and status details.
Options are:
• ipPolicingAlarmStatus - This table contains system
policer alarm status.
- aclAlarmDuration - Specifies the number of seconds
the system access control list policer alarm has been at
this level.
- aclAlarmLevel - Specifies the system access control
list policer alarm level.
- aclDiscardRate - Specifies the current rate of access
control list discards for the system.
- aclPacketsAccepted - Specifies the total number of
packets accepted by access control list policers on the
system.
- aclPacketsDiscarded - Specifies the total number of
packets discarded by access control list policers on the
system.
- aggregateAlarmDuration - Specifies the number of
seconds the system aggregate policer alarm has been at
this level.
- aggregateAlarmLevel - Specifies the system
aggregate policer alarm level.
- aggregateDiscardRate - Specifies the current rate of
aggregate discards for the system.
- aggregatePacketsAccepted - Specifies the total
number of packets accepted by aggregate policers on the
system.
- aggregatePacketsDiscarded - Specifies the total
number of packets discarded by aggregate policers on the
system.
- arpAlarmDuration - Specifies the number of seconds
the system ARP policer alarm has been at this level.
- arpAlarmLevel - Specifies the system ARP policer
alarm level.
- arpDiscardRate - Specifies the current rate of ARP
discards for the system.
- arpPacketsAccepted - Specifies the total number of
ARP packets accepted on the system.
- arpPacketsDiscarded - Specifies the total number of
packets discarded by ARP policers on the system.
2–87
show
Parameter
alarms
(continued)
Field
Length
N/A
Description
- badEthernetIpHeaderAlarmDuration - Specifies
the number of seconds the system bad Ethernet/IP Header
policer alarm has been at this level.
- badEthernetIpHeaderAlarmLevel - Specifies the
system bad Ethernet/IP Header policer alarm level.
- badEthernetIpHeaderDiscardRate - Specifies the
current rate of bad Ethernet/IP Header discards for the
system.
- badEthernetIpHeaderPacketsDiscarded Specifies the total number of packets discarded by bad
Ethernet/IP Header policers on the system.
- discardRuleAlarmDuration - Specifies the number
of seconds the system discard rule discard alarm has been
at this level.
- discardRuleAlarmLevel - Specifies the system
discard rule discard alarm level.
- discardRuleDiscardRate - Specifies the current rate
of discard rule discards for the system.
- discardRulePacketsDiscarded - Specifies the total
number of packets discarded by discard rule on the
system.
- ipSecDecryptAlarmDuration - Specifies the number
of seconds the system IPSEC decrypt policer alarm has
been at this level.
- ipSecDecryptAlarmLevel - Specifies the system
IPSEC decrypt policer alarm level.
- ipSecDecryptDiscardRate - Specifies the current
rate of IPSEC decrypt discards for the system.
- ipSecDecryptPacketsDiscarded - Specifies the total
number of packets discarded by IPSEC decrypt policers on
the system.
- mediaAlarmDuration - Specifies the number of
seconds the system media policer alarm has been at this
level.
- mediaAlarmLevel - Specifies the system media policer
alarm level.
- mediaDiscardRate - Specifies the current rate of
media discards for the system.
2–88
show
Parameter
Field
Length
Description
alarms(continu N/A
ed)
- mediaPacketsDiscarded - Specifies the total number
of packets discarded by media policers on the system.
- rogueMediaAlarmDuration - Specifies the number of
seconds the system rogue media policer alarm has been at
this level.
- rogueMediaAlarmLevel - Specifies the system rogue
media policer alarm level.
- rogueMediaDiscardRate - Specifies the current rate
of rogue media discards for the system.
- rogueMediaPacketsDiscarded - Specifies the total
number of packets discarded by rogue media policers on
the system.
- uFlowAlarmDuration - Specifies the number of
seconds the system microflow policer alarm has been at
this level.
- uFlowAlarmLevel - Specifies the system micro flow
policer alarm level.
- uFlowDiscardRate - Specifies the current rate of micro
flow discards for the system.
- uFlowPacketsAccepted - Specifies the total number of
packets accepted by micro flow policers on the system.
- uFlowPacketsDiscarded - Specifies the total number
of packets discarded by micro flow policers on the system.
Example
To display status of OAM SNMP objects:
show status oam snmp community engineId
engineId 80:00:0b:3f:03:00:10:6b:02:c7:ef;
To display status of OAM Eventlog objects:
show status oam eventLog typeStatus security
currentFile
1000006.SEC;
fileRecords
6;
fileBytes
986;
totalFiles
31;
totalFileBytes 10955;
memoryRecords
0;
memoryBytes
0;
filesDropped
0;
2–89
show
memoryDropped
0;
nextRollover
0;
logDestination localDisk;
lastFileDrop
0000-00-00T00:00:00Z;
lastMemoryDrop 0000-00-00T00:00:00Z;
Command Syntax
To display status of system objects:
> show status system hardDiskStatus
present <false|true>
productId <productId>
revision
capacity
diskStatus
> show status system hardDiskUsage
totalDiskSpace
freeDiskSpace
usedDiskSpace
role
syncStatus
syncCompletion
> show status system fanStatus
speed
> show status system powerSupplyStatus
present
productName
serialNum
partNum
powerFault
voltageFault
> show status system syncStatus
status
> show status system serverStatus
hwType
serialNum
partNum
platformVersion
applicationVersion
mgmtRedundancyRole
upTime
applicationUpTime
lastRestartReason
syncStatus
daughterBoardPresent
2–90
show
> show status system daughterBoardStatus
present
productName
serialNum
partNum
> show status system serverSoftwareUpgradeStatus
upgradeStatus
> show status system licenseStatus cemode
> show status system licenseInfo <license-id> expirationDate
usageLimit
> show status system softwareUpgradeStatus
upgradeStartTime
revertStartTime
package
rpmName
upgradeScript
revertScript
reason
cemodeAtStart
oldRelease
newRelease
activeCeAtStart
modelChange
primaryUpgradeStatus
secondaryUpgradeStatus
> show status system baseMacAddress <server-name>
assignedBaseAddress
activeBaseAddress
> show status system dspStatus
dspUsage
amrNbTotal
amrNbUtilization
amrWbTotal
amrWbUtilization
compressionAllocFailures
compressionTotal
compressionUtilization
ecmTotal
ecmUtilization
evrc0AllocFailures
evrc0Total
evrc0Utilization
evrcb0Total
evrcb0Utilization
g711Total
g711Utilization
g722Total
g722Utilization
g726Total
g726Utilization
2–91
show
g729AbTotal
g729AbUtilization
g7231Total
g7231Utilization
ilbcTotal
ilbcUtilization
toneAllocFailures
toneTotal
toneUtilization
> show status system ipPolicing
aclOffendersList
arpOffendersList
displaylevel
mediaOffendersList
systemCurStats
systemIntStats
uFlowOffendersList
> show status system ntp
peerStatus <ipaddress>
state
stratum
refTime
> show status system ntp
systemStatus <serverName>
clock
refTime
> show status system security pki
certChainStatus
certStatistics
certificate
displaylevel
> show status system security pki
certStatistics <serverName>
localCerts
caCerts
validationSuccess
validationFailures
badPeerCertificates
> show status system mgmtIpInterfaceGroup <mgmtGroup>
mgmtIpInterfaceStatus
operStatus
ifindex
2–92
show
rxPackets
txPackets
> show status system ethernetPort packetPortStatus <portname>
ifIndex
macAddress
negotiatedSpeed
linkState
> show status system ethernetPort packetStatistics
rxPackets
txPackets
rxErrors
txErrors
rxDropped
txDropped
> show status system ethernetPort mgmtPortStatus
ifIndex
macAddress
linkState
rxPackets
txPackets
rxErrors
txErrors
rxDropped
txDropped
> show status system ethernetPort mgmtStatistics
rxPackets
txPackets
rxErrors
txErrors
rxDropped
txDropped
show status system highAvailabilityPort <portname>
status
macAddress
ipAddress
negotiatedSpeed
oosReason
show status system highAvailabilityPort statistics
<portname>
packetTx
byteTx
errTx
packetRx
byteRx
crcErrRx
overErrRx
2–93
show
noBufCntRx
allocRxBufFailRx
show status system dspRes
dspCallCurrentStatistics
numCallFailNoAmrwb
numCallFailNoEvrc
numCallFailNoEvrcb0
numCallFailNoG711Packet
numCallFailNoG722
numCallFailNoG723
numCallFailNoG726
numCallFailNoG729
numCallFailNoGsm
numCallFailNoIlbc
numCallFailNoTone
numCallFailOtherOnAmrwb
numCallFailOtherOnEvrc
numCallFailOtherOnEvrcb0
numCallFailOtherOnG711Packet
numCallFailOtherOnG722
numCallFailOtherOnGsm
numCallFailOtherOnIlbc
numCallFailOtherOnTone
numCallSuccessNoAmrwb
numCallSuccessNoDspAllocFailure
numCallSuccessNoEvrc
numCallSuccessNoEvrcb0
numCallSuccessNoG711Packet
numCallSuccessNoG722
numCallSuccessNoGsm
numCallSuccessNoIlbc
numCallSuccessNoTone
numCallSuccessWithDspAllocFailure
> show status system dspRes
dspCallIntervalStatistics
intervalValid
numCallFailNoAmrwb
numCallFailNoEvrc
numCallFailNoEvrcb0
numCallFailNoG722
numCallFailNoG723
numCallFailNoG726
numCallFailNoG729
numCallFailNoGsm
numCallFailNoIlbc
numCallFailNoTone
2–94
show
numCallSuccessNoGsm
numCallSuccessWithDspAllocFailure
time
dspUsageCurrentStatistics
G711PacketAverageAvailCount
G711PacketAverageUsedCount
G711PacketPeakUsedCount
G722AverageAvailCount
G722AverageUsedCount
G722PeakUsedCount
G723PeakUsedCount
G726PeakUsedCount
G729PeakUsedCount
ToneAverageAvailCount
ToneAverageUsedCount
TonePeakUsedCount
amrwbAverageAvailCount
amrwbAverageUsedCount
amrwbPeakUsedCount
evrcAverageAvailCount
evrcAverageUsedCount
evrcPeakUsedCount
evrcb0AverageAvailCount
evrcb0AverageUsedCount
2–95
show
evrcb0PeakUsedCount
gsmAverageAvailCount
gsmAverageUsedCount
gsmPeakUsedCount
ilbcAverageAvailCount
ilbcAverageUsedCount
ilbcPeakUsedCount
dspUsageIntervalStatistics
G711PacketAverageAvailCount
G722PeakUsedCount
G723PeakUsedCount
G726PeakUsedCount
G729PeakUsedCount
TonePeakUsedCount
amrwbPeakUsedCount
evrcPeakUsedCount
evrcb0PeakUsedCount
gsmAverageUsedCount
gsmPeakUsedCount
ilbcPeakUsedCount
intervalValid
time
> show status system systemCongestionStatus
systemCongestionMCLevel
systemCongestionCPULevel
systemCongestionMemLevel
systemCongestionCallRateLevel
systemCongestionMCDuration
systemCongestionCallArrivalRate
systemCongestionCallAcceptRate
systemCongestionCallAcceptCount
2–96
show
systemCongestionCallEqArrivalRate
systemCongestionRegArrivalRate
> show status system systemCongestionCurrentStatistics
levelMC1Count
levelMC1TotalTime
levelMC2Count
levelMC2TotalTime
levelMC3Count
levelMC3TotalTime
overloadRejects
avgCallRate
peakCallRate
callArrivals
emergencyCallArrivals
emergencyCallRejects
sipRegArrivals
sipRegRejects
avgRegRate
peakRegRate
> show status system systemCongestionIntervalStatistics
intervalValid
time
levelMC1Count
levelMC1TotalTime
levelMC2Count
levelMC2TotalTime
levelMC3Count
levelMC3TotalTime
overloadRejects
avgCallRate
peakCallRate
callArrivals
emergencyCallArrivals
emergencyCallRejects
sipRegArrivals
sipRegRejects
avgRegRate
peakRegRate
> show status system announcements memoryUsage
cachedSegments
totalCacheMemory
totalPlayoutTime
totalSegments
usedCacheMemory
utilizedCacheMemory
> show status system policyServer policyServerStatus
ipAddress
<IP address>
2–97
show
Command Parameters
TABLE 2–13 System Parameters
Parameter
Field
Length
hardDiskStatus
N/A
Description
Specifies the hard disk status on the server(s). Options
are:
• present - Indicates if the hard disk exists. Options are:
true and false.
• productId - Specifies the product ID of the hard disk as
assigned by the vendor.
• revision - Specifies the revision of the hard disk as
assigned by the vendor.
• capacity - Specifies the capacity of the disk.
• diskStatus - Specifies the hard disk status whether the
disk is online or failed. Options are: failed, missing,
online and unknown.
hardDiskUsage
N/A
Specifies the hard disk status on the server(s). Options
are:
• freeDiskSpace - Indicates free hard disk space (KBytes).
• role - Specifies the role of the server for the indicated
partition. Options are primary and secondary.
• syncCompletion - Specifies the completion percentage of
the partition synchronization.
• syncStatus - Specifies the partition synchronization status
with peer server. Options are: synchronized,
synchronizingDestination,
synchronizingSource, unknown and unprotected.
• totalDiskSpace - Specifies the capacity of the disk
(KBytes).
• usedDiskSpace - Specifies the used hard disk percentage.
fanStatus
N/A
Specifies the fan status on the server(s). Option is:
• speed - Indicates the fan speed in RPM.
powerSupplySta
tus
N/A
Specifies the power consumption or state of the server.
Options are:
•
•
•
•
partNum - Identifies the part number of the module.
powerFault - Indicates if there is power fault.
present - Indicates if the module is present or not.
productName - Identifies the name (as given by
manufacturer) of power supply module.
• serialNum - Identifies the serial number of the power
supply module.
• voltageFault - Indicates if there is a voltage fault.
2–98
show
TABLE 2–13 System Parameters (Continued)
Parameter
Field
Length
syncStatus
N/A
Description
Specifies the system server synchronization status table,
describes data synchronization state of various items.
Option is:
• status - Indicates the inter-CE data synchronization
state. Options are: syncCompleted, syncInProgress
and unprotected.
serverStatus
N/A
The system server status table describes the status of the
server module. Options are:
• applicationUpTime - Indicates the application uptime on
the server in days/hours/minutes/sec.
• applicationVersion - Indicates the application version
currently running on the server.
• daughterBoardPresent - Indicates if the daughter board
exists.
• hwType - Identifies the type of server module the indexed
slot has been configured to accept.
• lastRestartReason - Indicates the reason for last restart
of the server.
• mgmtRedundancyRole - Indicates the redundancy role of
the server (for management entities).
• partNum - Identifies the part number of the module.
• platformVersion - Indicates the platform version
currently running on the server.
• serialNum - Identifies the serial number of the server
module.
• syncStatus - Indicates the inter-CE data synchronization
state.
• upTime - Indicates the server module uptime in days/hours/
minutes/sec.
daughterBoardS
tatus
N/A
Indicates the daughter board status on the server.
Options are:
• partNum - Identifies the part number of the module.
• present - Indicates if the module is present or not.
• productName - Identifies the name (as given by
manufacturer) of the module.
• serialNum - Identifies the serial number of the daughter
board module.
serverSoftware
UpgradeStatus
N/A
The system server software upgrade status table
describes the status of the server software upgrade
module. Option is:
• upgradeStatus - Indicates the current status of the server.
2–99
show
Parameter
Field
Length
licenseStatus
N/A
Description
The CE license status table describes the state of license
information. Option is:
• ceMode - Specifies the current CE license state.
license-id
N/A
Specifies the license ID.
licenseInfo
N/A
The license status for registered license features. Options
are:
• expirationDate - Specifies the licence expiry date for a
feature.
• usageLimit - Specifies the usage limit of a feature.
softwareUpgrad
eStatus
N/A
Specifies the live software upgrade status at any given
time.
• activeCeAtStart - Specifies the active CE name when
the upgrade started.
• cemodeAtStart - Specifies the CE mode when upgrade
started (single/dual).
• modelChange - Indicates if the process model changed as
part of this upgrade.
• newRelease - Specifies the software release to which the
upgrade is performed.
• oldRelease - Specifies the software release that was
running before upgrade started.
• package - Specifies the name of the new package.
• previousState - Specifies the previous LSWU state.
• primaryUpgradeStatus - Specifies the current status of
the primary server.
• reason - Specifies the exit reason for failure of the last
software upgrade.
• revertScript - Specifies the script to run to perform revert
in case upgrade fails.
• revertStartTime - Indicates when the live software
upgrade started.
• rpmName - Specifies the name of the new RPM used for
upgrade.
• secondaryUpgradeStatus -Specifies the current status
of the secondary server.
• state - This is the current LSWU state.
• upgradeScript - Script to run to perform upgrade.
• upgradeStartTime - Indicates when the live software
upgrade started.
server-name
2–100
N/A
Specifies the name of the server.
show
Parameter
Field
Length
Description
baseMacAddress
N/A
Displays base MAC address of the servers. Options are:
• activeBaseAddress - Specifies the MAC address base
assigned to the active server.
• assignedBaseAddress - Specifies the MAC address base
assigned to this server.
• currentBaseAddress - Specifies the MAC address base
assigned to this server at this time.
dspStatus
N/A
Specifies the status of the DSP resources. Options are:
• dspUsage - Specifies the current DSP resource usage.
Options are:
- amrNbAllocFailures - Specifies the percentage of
AMR-NB resources allocation failures on this server.
- amrNbTotal - Specifies the total number of AMR-NB
resources available on this server.
- amrNbUtilization - Specifies the percentage
utilization of AMR-NB resources on this server.
- amrWbAllocFailures - Specifies the percentage of
AMR-WB resources allocation failures on this server.
- amrWbTotal - Specifies the total number of AMR-WB
- amrWbUtilization - Specifies the percentage utilization
of AMR-WB resources on this server.
- compressionAllocFailures - Specifies the percentage
of compression resources allocation failures on this server.
- compressionTotal - Specifies the total number of
compression resources available on this server.
- compressionUtilization - Specifies the percentage
utilization of compression resources on this server.
- ecmAllocFailures - Specifies the percentage of T.38
ECM resources allocation failures on this server.
- ecmTotal - Specifies the total number of T.38 ECM
- ecmUtilization - Specifies the percentage utilization of
T.38 ECM resources on this server.
- evrc0AllocFailures - Specifies the percentage of
EVRC0 resources allocation failures on this server.
- evrc0Total - Specifies the total number of EVRC0
2–101
show
Parameter
Field
Length
dspStatus(cont N/A
inued)
Description
- evrc0Utilization - Specifies the percentage
utilization of EVRC0 resources on this server.
- evrcb0AllocFailures - Specifies the percentage of
EVRCB0 resources allocation failures on this server.
- evrcb0Total - Specifies the total number of EVRCB0
- evrcb0Utilization - Specifies the percentage
utilization of EVRCB0 resources on this server.
- g711Total - Specifies the total number of G711
- g711Utilization - Specifies the percentage utilization
of G711 resources on this server.
- g722AllocFailures - Specifies the percentage of G.722
resources allocation failures on this server.
- g722Total - Specifies the total number of G.722
of G.722 resources on this server.
- g726Total - Specifies the total number of G726
- g729AbTotal - Specifies the total number of G729A+B
- g729AbUtilization - Specifies the percentage
utilization of G729A+B resources on this server.
- g7231Total - Specifies the total number of G723.1
- ilbcAllocFailures - Specifies the percentage of iLBC
resources allocation failures on this server.
- ilbcTotal - Specifies the total number of iLBC
- ilbcUtilization - Specifies the percentage utilization
of iLBC resources on this server.
- toneAllocFailures - Specifies the percentage of Tone
resource allocation failures on this server.
2–102
show
Parameter
dspStatus
(continued)
Field
Length
N/A
Description
- toneTotal - Specifies the total number of Tone
- toneUtilization - Specifies the percentage utilization
of Tone resources on this server.
ipPolicing
N/A
Specifies the MIB module for IP Monitoring. Options are:
• aclOffendersList - Specifies the table of statistics for
the access control list policer offenders list.
• aggregateOffendersList - Specifies the table of
statistics for the aggregate policer offenders list.
• arpOffendersList - Specifies the table of statistics for
the ARP policer offenders list.
• badEthernetHdrOffendersList - Specifies the table of
statistics for the bad Ethernet/IP Header policer offenders
list.
• discardRuleOffendersList - Specifies the table of
statistics for the discard rule offenders list.
• ipSecDecryptdiscardRuleOffendersList - Specifies
the table of statistics for the IPSEC Decrypt policer offenders
list.
• mediaOffendersList - Specifies the table of statistics for
the media policer offenders list.
• rougeMediaOffendersList - Specifies the table of
statistics for the rogue media policer offenders list.
• systemCurStats - Specifies the Sonus System Policer
Current table.
• systemIntStats - Specifies the Sonus System Policer
Interval table.
• uFlowOffendersList - Specifies the table of statistics
for the micro flow policer offenders list.
2–103
show
Parameter
Field
Length
Description
ntp
N/A
Specifies the NTP services management. Options are:
• peerStatus - Specifies the status information about each
NTP peer.
- refTime - Specifies the time this NTP peer was last
updated.
- state - Identifies the state of the NTP peer.
- stratum - Identifies the NTP peer's stratum level, 16 =
invalid.
• systemStatus - This table contains system status
information about NTP.
- clock - Specifies the system clock time.
- refTime - Specifies the time this system was last
updated.
certStatistics N/A
Displays the statistics of the certificate.
•
•
•
•
•
badPeerCertificates - Specifies the number of bad or
malformed peer certificates presented for validation.
caCerts - Specifies the number of installed CA or remote
certificates.
localCerts - Specifies the number of installed local
certificates.
validationFailures - Specifies the number of failed
certificate validations.
validationSuccess - Specifies the number of successful
certificate validations.
serverName
N/A
Specifies the name of the server.
mgmtGroup
N/A
Specifies the name of the management IP interface
group.
mgmtIpInterfac
eStatus
N/A
The status of the IP interfaces in this IP interface group.
Options are:
• ifindex - Specifies the interface index of the MGMT LIF.
• operStatus - Specifies the actual status of the
management interface.
• rxPackets - Specifies the number of packets received on
this MGMT LIF.
• txPackets - Specifies the number of packets sent on this
MGMT LIF.
2–104
show
Field
Length
Description
packetPortStat
us
N/A
Specifies the status of the packet port. Options are:
port-name
N/A
Specifies the name of the packet port.
packetStatisti
cs
N/A
Specifies the statistics of the packet port.
mgmtPortStatus
N/A
Parameter
• ifindex - Specifies the unique ifindex of this Packet NIF.
• linkStatus - Specifies the state of the interface.
• macAddress - Specifies the MAC address of the network
interface.
• negotiatedSpeed - Specifies the interface speed.
• rxDropped - Specifies the number of packets dropped due
to no receive buffers.
• rxErrors - Specifies the number of bad packets received
• rxPackets - Specifies the number of received packets.
• txDropped - Specifies the number of packets dropped due
to no transmit buffers.
• txErrors - Specifies the number of packet transmit
failures.
• txPackets - Specifies the number of transmitted packets.
Specifies the status of the management port. Options are:
• ifindex - Specifies the unique ifIndex of this
management NIF.
• linkState - Specifies the state of the interface.
• macAddress - Specifies the MAC address of the network
interface.
failures.
2–105
show
Parameter
Field
Length
mgmtStatistics
N/A
Description
Specifies the statistics of the management port. Options
are:
failures.
portname
N/A
Specifies the name of the high availability port.
status
N/A
Specifies the status of the high availability port. Options
are:
• ipAddress - Specifies the IP address of this port.
• macAddress - Specifies the MAC address of this port.
• negotiatedSpeed - Specifies the negotiated speed of this
port.
• oosReason - Specifies the reason this port is out-of-service.
statistics
N/A
Specifies the statistics of the high availability port.
Options are:
• allocRxBufFailRx - Specifies the number of receive
buffer allocation errors.
• byteRx - Specifies the number of bytes received.
• byteTx - Specifies the number of bytes transmitted.
• crcErrRx - Specifies the number of receive CRC errors.
• errTx - Specifies the number of transmit errors.
• noBufCntRx - Specifies the number of receive no buffer
errors.
• ovrErrRx - Specifies the number of receive overrun errors.
• packetRx - Specifies the number of packets received.
• packetTx - Specifies the number of packets transmitted.
2–106
show
Parameter
dspCallCurrent
Statistics
Field
Length
N/A
Description
Specifies the Sonus system call DSP resource current
table. Options are:
• numCallFailNoAmrwb - Specifies the number of calls
failed due to lack of AMRWB DSP resource during the
current interval time.
• numCallFailNoEvrc - Specifies the number of calls failed
due to lack of EVRC DSP resource during the current
interval time.
• numCallFailNoEvrcb0 - Specifies the number of calls
failed due to lack of EVRCB0 DSP resource during the
current interval time.
• numCallFailNoG711Packet - Specifies the number of
calls failed due to lack of G711 Packet DSP resource during
the current interval time.
• numCallFailNoG722 - Specifies the number of calls failed
due to lack of G722 DSP resource during the current interval
time.
time.
time.
time.
• numCallFailNoGsm - Specifies the number of calls failed
due to lack of AMRNB DSP resource during the current
interval time.
• numCallFailNoIlbc - Specifies the number of calls failed
due to lack of ILBC DSP resource during the current interval
time.
• numCallFailNoTone - Specifies the number of calls failed
due to lack of TONE DSP resource during the current
interval time.
• numCallFailOtherOnAmrwb - Specifies the number of
call fail due to reason other than lack of AMRWB DSP
resource during the current interval time.
• numCallFailOtherOnEvrc - Specifies the number of call
fail due to reason other than lack of EVRC DSP resource
during the current interval time.
• numCallFailOtherOnEvrcb0 - Specifies the number of
call fail due to reason other than lack of EVRCB0 DSP
2–107
show
Parameter
Field
Length
dspCallCurrent N/A
Statistics(con
tinued)
2–108
Description
• numCallFailOtherOnG711Packet - Specifies the
number of call fail due to reason other than lack of G711
Packet DSP resource during the current interval time.
• numCallFailOtherOnG722 - Specifies the number of call
fail due to reason other than lack of G722 DSP resource
• numCallFailOtherOnGsm - Specifies the number of call
fail due to reason other than lack of AMRNB DSP resource
• numCallFailOtherOnIlbc - Specifies the number of call
fail due to reason other than lack of ILBC DSP resource
• numCallFailOtherOnTone - Specifies the number of call
fail due to reason other than lack of TONE DSP resource
• numCallSuccessNoAmrwb - Specifies the number of
successful calls even if there is a lack of AMRWB DSP
• numCallSuccessNoDspAllocFailure - Specifies the
number of successful calls without DSP resource allocation
failure during the current interval time.
• numCallSuccessNoEvrc - Specifies the number of
successful calls even if there is a lack of EVRC DSP
• numCallSuccessNoEvrcb0 - Specifies the number of
successful calls even if there is a lack of EVRCB0 DSP
• numCallSuccessNoG711Packet - Specifies the number
of successful calls even if there is a lack of G711 Packet
DSP resource during the current interval time.
• numCallSuccessNoG722 - Specifies the number of
successful calls even if there is a lack of G722 DSP resource
show
Parameter
Field
Length
dspCallCurrent N/A
Statistics(con
tinued)
dspCallInterva
lStatistics
N/A
Description
• numCallSuccessNoGsm - Specifies the number of
successful calls even if there is a lack of AMRNB DSP
• numCallSuccessNoIlbc - Specifies the number of
successful calls even if there is a lack of ILBC DSP resource
• numCallSuccessNoTone - Specifies the number of
successful calls even if there is a lack of TONE DSP
• numCallSuccessWithDspAllocFailure - Specifies the
number of successful calls with DSP resource allocation
failure during the current interval time.
Specifies the Sonus system call DSP resource interval
table. Options are:
• numCallFailNoAmrwb - Specifies the number of calls
failed due to lack of AMRWB DSP resource during a interval
time.
• numCallFailNoEvrc - Specifies the number of calls failed
due to lack of EVRC DSP resource during an interval time.
• numCallFailNoEvrcb0 - Specifies the number of calls
failed due to lack of EVRCB0 DSP resource during an
interval time.
• numCallFailNoG711Packet - Specifies the number of
calls failed due to lack of G711 Packet DSP resource during
a interval time.
due to lack of G722 DSP resource during an interval time.
• numCallFailNoGsm - Specifies the number of calls failed
due to lack of AMRNB DSP resource during an interval time.
2–109
show
Parameter
dspCallInterva
lStatistics
2–110
Field
Length
N/A
Description
• numCallFailNoIlbc - Specifies the number of calls failed
due to lack of ILBC DSP resource during an interval time.
• numCallFailNoTone - Specifies the number of calls failed
due to lack of TONE DSP resource during an interval time.
• numCallFailOtherOnAmrwb - Specifies the number of
call fail due to reason other than lack of AMRWB DSP
resource during an interval time.
• numCallFailOtherOnEvrc - Specifies the number of call
fail due to reason other than lack of EVRC DSP resource
during an interval time.
• numCallFailOtherOnEvrcb0 - Specifies the number of
call fail due to reason other than lack of EVRCB0 DSP
• numCallFailOtherOnG711Packet - Specifies the
number of call fail due to reason other than lack of G711
Packet DSP resource during an interval time.
• numCallFailOtherOnGsm - Specifies the number of call
fail due to reason other than lack of AMRNB DSP resource
• numCallFailOtherOnIlbc - Specifies the number of call
fail due to reason other than lack of ILBC DSP resource
• numCallFailOtherOnTone - Specifies the number of call
fail due to reason other than lack of TONE DSP resource
• numCallSuccessNoAmrwb - Specifies the number of
successful calls even if there is a lack of AMRWB DSP
• numCallSuccessNoDspAllocFailure - Specifies the
number of successful calls without DSP resource allocation
failure during an interval time.
show
Parameter
Field
Length
dspCallInterva N/A
lStatistics(co
ntinued)
Description
• numCallSuccessNoEvrc - Specifies the number of
successful calls even if there is a lack of EVRC DSP
• numCallSuccessNoEvrcb0 - Specifies the number of
successful calls even if there is a lack of EVRCB0 DSP
• numCallSuccessNoG711Packet - Specifies the number
of successful calls even if there is a lack of G711 Packet
DSP resource during an interval time.
• numCallSuccessNoGsm - Specifies the number of
successful calls even if there is a lack of AMRNB DSP
• numCallSuccessNoIlbc - Specifies the number of
successful calls even if there is a lack of ILBC DSP resource
• numCallSuccessNoTone - Specifies the number of
successful calls even if there is a lack of TONE DSP
• numCallSuccessWithDspAllocFailure - Specifies the
number of calls that are successful with DSP resource
allocation failure during an interval time.
• time - The system up time when the interval statistics is
collected.
2–111
show
Parameter
dspUsageCurren
tStatistics
Field
Length
N/A
Description
Specifies the Sonus DSP resource current table. Options
are:
• G711PacketAverageAvailCount - Specifies the current
average availability of type G711Packet DSP PAD.
• G711PacketAverageUsedCount - Specifies the current
average usage of type G711Packet DSP PAD.
• G711PacketPeakUsedCount - Specifies the current peak
usage of type G711Packet DSP PAD.
• G722AverageAvailCount - Specifies the current average
availability of type G722 DSP PAD.
• G722AverageUsedCount - Specifies the current average
usage of type G722 DSP PAD.
• G722PeakUsedCount - Specifies the current peak usage of
type G722 DSP PAD.
type G723 DSP PAD.
type G726 DSP PAD.
• G729PeakUsedCount - Specifies the current Peak usage of
type G729 DSP PAD.
• ToneAverageAvailCount - Specifies the current average
availability of type TONE DSP PAD.
• ToneAverageUsedCount - Specifies the current average
usage of type TONE DSP PAD.
• TonePeakUsedCount - Specifies the current peak usage of
type TONE DSP PAD.
• amrwbAverageAvailCount - Specifies the current
average availability of type AMRWB DSP PAD.
2–112
show
Parameter
Field
Length
dspUsageCurren N/A
tStatistics(co
ntinued)
Description
• amrwbAverageUsedCount - Specifies the current average
usage of type AMRWB DSP PAD.
• amrwbPeakUsedCount - Specifies the current peak usage
of type AMRWB DSP PAD.
• evrcAverageAvailCount - Specifies the current average
availability of type EVRC DSP PAD.
• evrcAverageUsedCount - Specifies the current average
usage of type EVRC DSP PAD.
• evrcPeakUsedCount - Specifies the current peak usage of
type EVRC DSP PAD.
• evrcb0AverageAvailCount - Specifies the current
average availability of type EVRCB0 DSP PAD.
• evrcb0AverageUsedCount - Specifies the current
average usage of type EVRCB0 DSP PAD.
• evrcb0PeakUsedCount - Specifies the current peak usage
of type EVRCB0 DSP PAD.
• gsmAverageAvailCount - Specifies the current average
availability of type AMRNB DSP PAD.
• gsmAverageUsedCount - Specifies the current average
usage of type AMRNB DSP PAD.
• gsmPeakUsedCount - Specifies the current peak usage of
type AMRNB DSP PAD.
• ilbcAverageAvailCount - Specifies the current average
availability of type ILBC DSP PAD.
• ilbcAverageUsedCount - Specifies the current average
usage of type ILBC DSP PAD.
• ilbcPeakUsedCount - Specifies the current peak usage of
type ILBC DSP PAD.
2–113
show
Parameter
dspUsageInterv
alStatistics
Field
Length
N/A
Description
Specifies the Sonus DSP resource interval table. Options
are:
• G711PacketAverageAvailCount - Specifies the average
availability of type G711Packet DSP pad during an interval
time.
• G711PacketAverageUsedCount - Specifies the average
usage of type G711Packet DSP pad during an interval time.
• G711PacketPeakUsedCount - Specifies the peak usage
of type G711Packet DSP pad during an interval time.
• G722AverageAvailCount - Specifies the average
availability of type G722 DSP pad during an interval time.
• G722AverageUsedCount - Specifies the average usage of
type G722 DSP pad during an interval time.
• G722PeakUsedCount - Specifies the peak usage of type
G722 DSP pad during an interval time.
• G723PeakUsedCount - Specifies the Interval number of
Peak usage of type G723 DSP pad during an interval time.
• G726PeakUsedCount - Specifies the Interval number of
Peak usage of type G726 DSP pad during an interval time.
• G729PeakUsedCount - Specifies the peak usage of type
G729 DSP pad during an interval time.
• ToneAverageAvailCount - Specifies the average
availability of type TONE DSP pad during an interval time.
• ToneAverageUsedCount - Specifies the average usage of
type TONE DSP pad during an interval time.
• TonePeakUsedCount - Specifies the peak usage of type
TONE DSP pad during an interval time.
• amrwbAverageAvailCount - Specifies the average
availability of type AMRWB DSP pad during an interval time.
2–114
show
Parameter
Field
Length
dspUsageInterv N/A
alStatistics(c
ontinued)
Description
• amrwbAverageUsedCount - Specifies the average usage
of type AMRWB DSP pad during an interval time.
• amrwbPeakUsedCount - Specifies the peak usage of type
AMRWB DSP pad during an interval time.
• evrcAverageAvailCount - Specifies the average
availability of type EVRC DSP pad during an interval time.
• evrcAverageUsedCount - Specifies the average usage of
type EVRC DSP pad during an interval time.
• evrcPeakUsedCount - Specifies the peak usage of type
EVRCB0 DSP pad during an interval time.
• evrcb0AverageAvailCount - Specifies the average
availability of type EVRCB0 DSP pad during an interval time.
• evrcb0AverageUsedCount - Specifies the average usage
of type EVRCB0 DSP pad during an interval time.
• evrcb0PeakUsedCount - Specifies the peak usage of type
EVRCB0 DSP pad during an interval time.
• gsmAverageAvailCount - Specifies the average
availability of type AMRNB DSP pad during an interval time.
• gsmAverageUsedCount - Specifies the average usage of
type AMRNB DSP pad during an interval time.
• gsmPeakUsedCount - Specifies the peak usage of type
AMRNB DSP pad during an interval time.
• ilbcAverageAvailCount - Specifies the average
availability of type ILBC DSP pad during an interval time.
• ilbcAverageUsedCount - Specifies the average usage of
type ILBC DSP pad during an interval time.
• ilbcPeakUsedCount - Specifies the peak usage of type
ILBC DSP pad during an interval time.
statistic is collected.
2–115
show
Parameter
systemCongesti
onStatus
2–116
Field
Length
Description
N/A
Specifies the system congestion status. Options are:
• systemCongestionCPULevel - Specifies the CPU
congestion level.
• systemCongestionCallAcceptCount - Specifies the
current number of calls being accepted by the system
measured in calls per second.
• systemCongestionCallAcceptRate - Specifies the
current rate at which calls are being accepted by the system.
• systemCongestionCallArrivalRate - Specifies the
current system call arrival rate.
• systemCongestionCallEqArrivalRate - Specifies the
current system call equivalence real call and registration
arrival rate
• systemCongestionCallRateLevel - Specifies the call
rate congestion level.
• systemCongestionMCDuration - Specifies the number
of seconds the system has been at this congestion level.
• systemCongestionMCLevel - Specifies the System
congestion level.
• systemCongestionMemLevel - Specifies the Memory
congestion level.
• systemCongestionRegArrivalRate - Specifies the
current system SIP registration arrival rate
show
Parameter
systemCongesti
onCurrentStati
stics
Field
Length
N/A
Description
The Sonus System Congestion Current Statistics table.
Options are:
• avgCallRate - Specifies the current system average call
arrival rate.
• avgRegRate - Specifies the current average SIP
registration arrival rate.
• callArrivals - Specifies the current number of call
arrivals.
• emergencyCallArrivals - Specifies the current number
of SIP emergency calls arrived.
• emergencyCallRejects - Specifies the current number of
SIP emergency calls arrived.
• levelMC1Count - Specifies the current number of
transitions into MC1
• levelMC1TotalTime - Specifies the current sum of time
spent in MC1
spent in MC2
spent in MC3
• overloadRejects - Specifies the current number of calls
rejected due to System congestion
• peakCallRate - Specifies the current system peak call
arrival rate
• peakRegRate - Specifies the current peak SIP registration
arrival rate
• sipRegArrivals - Specifies the current number of SIP
registrations arrived
• sipRegRejects - Specifies the current number of SIP
registrations rejected
2–117
show
Parameter
systemCongesti
onIntervalStat
istics
2–118
Field
Length
N/A
Description
The Sonus System Congestion Interval Statistics table.
Options are:
• avgCallRate - Specifies the current system average call
arrival rate.
• avgRegRate - Specifies the current average SIP
registration arrival rate.
• callArrivals - Specifies the current number of call
arrivals.
• emergencyCallArrivals - Specifies the current number
of SIP emergency calls arrived.
• emergencyCallRejects - Specifies the current number of
SIP emergency calls arrived
spent in MC1
spent in MC2
spent in MC3
• overloadRejects - Specifies the current number of calls
rejected due to System congestion
• peakCallRate - Specifies the current system peak call
arrival rate
• peakRegRate - Specifies the current peak SIP registration
arrival rate
• sipRegArrivals - Specifies the current number of SIP
registrations arrived
• sipRegRejects - Specifies the current number of SIP
registrations rejected
show
Parameter
Field
Length
memoryUsage
N/A
Description
Specifies the announcement segment NP memory
usage. Options are:
• cachedSegments - Specifies the number of announcement
segments cached in NP memory
• totalCachedMemory - Specifies the total amount of
segment cache memory available in NP
• totalPlayoutTime - Specifies the total playout time of all
segments cached in NP memory
• totalSegments - Specifies the total number of
announcement segments on disk
• usedCachedMemory - Specifies the amount of segment
cache memory being used in NP
• utilizedCachedMemory - Specifies the percentage of
segment cache memory being used in NP
IP address
N/A
Specifies the IP address of the softswitch server.
Example
To view the status of announcement segment NP memory usage of SBC 5x00:
admin@server1> show status system announcements memoryUsage
server1
totalSegments
0;
cachedSegments
0;
totalCacheMemory
"125819520 bytes";
usedCacheMemory
"0 bytes";
utilizedCacheMemory 0%;
totalPlayoutTime
"0h: 0m: 0s";
[ok][2011-02-09 06:15:15]
To view the status of the PSX server PSX_LOCAL_SERVER:
admin@server1> show status system policyServer
policyServerStatus ipAddress 127.0.0.1
policyServerStatus PSX_LOCAL_SERVER {
index
0;
operState
Active;
ipAddress
127.0.0.1;
averageTransactionTime
0;
serverReconnects
0;
transactionCompleted
2;
2–119
show
transactionRetryAttempts
0;
transactionFailedAttempts 0;
version
23;
redirectRequests
0;
releaseRequests
0;
dataRequests
0;
queriesSkippedAndServiced 0;
queriesSkippedAndRejected 0;
congestionLevel
0;
allowancePercent
100;
}
To view the current call statistics of the DSP Resource pad:
show status system dspRes dspCallCurrentStatistics
dspCallCurrentStatistics sbx10 {
0;
numCallSuccessWithDspAllocFailure 0;
2–120
numCallFailNoG729
0;
0;
0;
numCallFailNoG726
0;
0;
0;
0;
0;
0;
numCallFailNoG723
0;
0;
0;
numCallFailNoIlbc
0;
0;
0;
numCallFailNoEvrcb0
0;
0;
0;
numCallFailNoGsm
0;
0;
numCallSuccessNoGsm
0;
numCallFailNoAmrwb
0;
show
0;
0;
numCallFailNoG722
0;
0;
0;
numCallFailNoTone
0;
0;
0;
numCallFailNoEvrc
0;
0;
0;
}
To view the call interval statistics of the DSP Resource pad:
show status system dspRes dspCallIntervalStatistics
dspCallIntervalStatistics 2 sbx10 {
intervalValid
true;
time
2549;
0;
numCallSuccessWithDspAllocFailure 0;
numCallFailNoG729
0;
0;
0;
numCallFailNoG726
0;
0;
0;
0;
0;
0;
numCallFailNoG723
0;
0;
0;
numCallFailNoIlbc
0;
0;
0;
numCallFailNoEvrcb0
0;
0;
0;
numCallFailNoGsm
0;
2–121
show
0;
numCallSuccessNoGsm
0;
numCallFailNoAmrwb
0;
0;
0;
numCallFailNoG722
0;
0;
0;
numCallFailNoTone
0;
0;
0;
numCallFailNoEvrc
0;
0;
0;
}
To view the DSP current usage statistics of the DSP Resource pad:
show status system dspRes dspUsageCurrentStatistics
dspUsageCurrentStatistics sbx10 {
G729PeakUsedCount
0;
0;
11;
G726PeakUsedCount
0;
0;
11;
0;
0;
G711PacketAverageAvailCount 11;
2–122
G723PeakUsedCount
0;
0;
11;
ilbcPeakUsedCount
0;
0;
11;
evrcb0PeakUsedCount
0;
0;
0;
gsmPeakUsedCount
0;
gsmAverageUsedCount
0;
show
0;
amrwbPeakUsedCount
0;
0;
0;
G722PeakUsedCount
0;
0;
0;
TonePeakUsedCount
0;
0;
0;
evrcPeakUsedCount
0;
0;
0;
}
To view the DSP usage interval statistics of the DSP Resource pad:
show status system dspRes dspUsageIntervalStatistics
dspUsageIntervalStatistics 3 sbx10 {
intervalValid
true;
time
3449;
G729PeakUsedCount
0;
0;
1276;
G726PeakUsedCount
0;
0;
1276;
0;
0;
G723PeakUsedCount
0;
0;
1276;
ilbcPeakUsedCount
0;
0;
1276;
evrcb0PeakUsedCount
0;
0;
0;
gsmPeakUsedCount
0;
2–123
show
gsmAverageUsedCount
0;
0;
amrwbPeakUsedCount
0;
0;
0;
G722PeakUsedCount
0;
0;
0;
TonePeakUsedCount
0;
0;
0;
evrcPeakUsedCount
0;
0;
0;
}
dspUsageIntervalStatistics 4 sbx10 {
intervalValid
true;
time
4349;
G729PeakUsedCount
0;
0;
1009;
G726PeakUsedCount
0;
0;
1009;
0;
0;
2–124
G723PeakUsedCount
0;
0;
1009;
ilbcPeakUsedCount
0;
0;
1009;
evrcb0PeakUsedCount
0;
0;
0;
gsmPeakUsedCount
0;
gsmAverageUsedCount
0;
show
0;
amrwbPeakUsedCount
0;
0;
0;
G722PeakUsedCount
0;
0;
0;
TonePeakUsedCount
0;
0;
0;
evrcPeakUsedCount
0;
0;
0;
}
To view the status of the DSP Resource pad:
show status system dspStatus
dspUsage sbx41 {
compressionTotal
4800;
compressionUtilization
0;
compressionAllocFailures 2;
g711Total
4800;
g711Utilization
0;
g726Total
4800;
g726Utilization
0;
g729AbTotal
4800;
g729AbUtilization
0;
g7231Total
4800;
g7231Utilization
0;
ilbcTotal
0;
ilbcUtilization
0;
ilbcAllocFailures
0;
ecmTotal
4800;
ecmUtilization
0;
ecmAllocFailures
2;
toneTotal
0;
toneUtilization
0;
toneAllocFailures
0;
evrcb0Total
0;
2–125
show
evrcb0Utilization
0;
evrcb0AllocFailures
0;
amrNbTotal
0;
amrNbUtilization
0;
amrNbAllocFailures
0;
amrWbTotal
0;
amrWbUtilization
0;
amrWbAllocFailures
0;
g722Total
0;
g722Utilization
0;
g722AllocFailures
0;
evrc0Total
0;
evrc0Utilization
0;
evrc0AllocFailures
0;
}
show table
The show table command displays the current configuration and status of the
SBC 5x00 system as a table. It displays the status of the following SBC 5x00
objects:
•
•
•
•
•
•
address context
alarms
global
profiles
system
Command Syntax
To view the configuration and status of Static IP routes for the address context as
a table:
> show table addressContext staticRoute
Example:
admin@server1> show table addressContext staticRoute
INTERVAL
NAME
NUMBER
NAME
VALID
TIME
INGRESS
EGRESS
INGRESS
E
FAIL
FAIL
FAIL
F
CALL
CALL
CALL
C
LIMIT
LIMIT
POLICING
P
------------------------------------------------------------------------------
2–126
show
default
44
DNS
true
40376
0
0
0
0
44
defaultSigZone
true
40376
0
0
0
0
45
DNS
true
41276
0
0
0
0
45
defaultSigZone
true
41276
0
0
0
0
46
DNS
true
42176
0
0
0
0
46
defaultSigZone
true
42176
0
0
0
0
47
DNS
true
43076
0
0
0
0
47
defaultSigZone
true
43076
0
0
0
0
[ok][2011-02-09 08:06:59]
During a switchover call history of only stable calls are maintained. In
callCountStatus table, all counters except STABLE CALLS are reset to zero
when there is a switchover (either force or manual).
To view the call count status for the server as a table before a switchover:
> show table global callCountStatus
Example:
show table global callCountStatus
ACTIVE
STABLE
TOTAL
TOTAL
CALLS
KEY
CALLS
CALLS
CALL
EMERG
CALL
ACTIVE STABLE CALL
ATTEMPTS COMPLETIONS
ESTABLISHING STABLE
CALLS
CALLS
NON
UPDATES
CALLS
NON
USER
CALLS
TOTAL NON
USER
TOTAL
EMERG
CALLS
USER
-----------------------------------------------------------------------------------------------------all
5
0
5
0
0
9
0
0
0
0
0
To switchover the management applications and restart “all” the applications:
> request system admin sbxsvtha switchover
This command will
restarts 'all'
server. Do you
result success
switchover the management applications and
the applications on currently active
want to proceed (yes/no) yes Proceeding
reason Performing Switchover...
To view the synchronisation status of the system as a table:
> show table system syncStatus
Example:
show table system syncStatus
SYNC MODULE
STATUS
--------------------------------------Policy Data
syncCompleted
2–127
show
Configuration Data
syncCompleted
Call/Registration Data
syncCompleted
To view the front panel LED status of the system:
> show table system ledStatus
SERVER
LED
LED
LED
NAME
TYPE
STATE
COLOR
------------------------------Irving
Alarm
on
amber
Irving
Power
on
green
Irving
Active
on
amber
Irving
Status
on
green
Irving
Locator
off
none
To view the license information of the application:
> show table system licenseInfo
FEATURE NAME
LICENSE
EXPIRATION
USAGE
ID
DATE
LIMIT
-----------------------------------------SRTP
0
ENCRYPT
0
SBC-RTU
0
DSP-EVRC
0
DSP-G722
0
DSP-AMRNB
0
DSP-AMRWB
0
SBC-SIP-I
0
SBC-SIP323
0
SBC-POL-RTU
0
SBC-POL-E911
0
SBC-POL-ENUM
0
To view the call count status for the server as a table after a switchover:
> show table global callCountStatus
Example:
show table global callCountStatus
ACTIVE
STABLE
TOTAL
TOTAL
CALLS
CALLS
2–128
CALLS
CALLS
TOTAL
CALLS
show
CALL
EMERG
KEY
CALL
ACTIVE STABLE CALL
ATTEMPTS COMPLETIONS
ESTABLISHING STABLE
CALLS
CALLS
NON
UPDATES
NON
TOTAL NON
USER
USER
EMERG
CALLS
USER
---------------------------------------------------------------------------------------------------all
0
0
0
0
0
0
0
0
0
0
0
To view the status of IP trunk groups in this zone:
> show table global globalTrunkGroupStatus
Example:
show table global globalTrunkGroupStatus
BW
INBOUND
TOTAL
BW
CALLS
OUTBOUN
TOTAL
CALLS
INBOUND OUTBOUND TOTAL
TOTAL
PRIORITY OUTBOUND BW
INBOUND
CALL
CALLS
CALLS
CALLS
CALLS
CURRENT BW
NAME
STATE
AVAILABLE RESERVED USAGE
USAGE
CONFIGURED USAGE
RESERVED LIMIT
AVAILABLE USAGE
USAGE
----------------------------------------------------------------------------------------------------------------------RHEL_1 inService -1
0
0
0
-1
0
0
-1
1
0
0
RHEL_2 inService -1
0
0
0
-1
0
0
-1
1
0
0
show users
The show users command displays the users currently logged on.
Command Syntax
To view the users currently logged on to SBC 5x00:
> show users
Example:
admin@server1> show users
SID USER
CTX FROM
PROTO LOGIN
*31 admin cli 10.6.81.50 ssh
CONFIG MODE
07:17:49
[ok][2011-02-09 08:25:00]
show utils
The show utils command displays the system utilities such as event log and
route table.
2–129
show
Command Syntax
To view the system utilities:
> show utils eventLog act
> show utils eventLog audit
> show utils eventLog dbg
> show utils eventLog sec
> show utils eventLog sys
> show utils eventLog trc
> show utils routeTable
Example:
To display the current trace event:
admin@server1> show utils eventLog trc
Sonus Networks,
Inc.0000000001600000000000000000000128000000000000010000000000000000000000000000T
RC2011020820021400000000000000
[ok][2011-02-09 08:45:53]
To display route table:
admin@server1> show utils routeTable
Kernel IP routing table
Destination
Gateway
Genmask
Flags Metric Ref
Use Iface
10.6.83.0
0.0.0.0
255.255.255.0
U
0
0
0 mgt1
10.6.82.0
0.0.0.0
255.255.255.0
U
0
0
0 mgt0
10.6.81.0
0.0.0.0
255.255.255.0
U
0
0
0 eth0
10.7.0.0
0.0.0.0
255.255.0.0
U
0
0
0 pkt0
10.7.0.0
0.0.0.0
255.255.0.0
U
0
0
0 pkt2
169.254.0.0
0.0.0.0
255.255.0.0
U
0
0
0 eth1
0.0.0.0
10.6.81.1
0.0.0.0
UG
0
0
0 eth0
0.0.0.0
10.6.83.1
0.0.0.0
UG
10
0
0 mgt1
0.0.0.0
10.6.82.1
0.0.0.0
UG
10
0
0 mgt0
0.0.0.0
10.6.82.1
0.0.0.0
UG
100
0
0 mgt0
0.0.0.0
10.6.83.1
0.0.0.0
UG
200
0
0 mgt1
[ok][2011-02-09 08:36:08]
2–130
source
source
The source operation is used to source a file containing CLI commands. This file
must be located in the directory /home/Administrator.
2–131
top
top
The top operation is used to exit to the top level. In Edit mode, the top
command takes you to the top most level of CLI commands from any level.
2–132
up
up
The up operation is used to exit one level of configuration. In Edit mode, the up
command takes you to one level up.
2–133
2–134
up
CHAPTER 3
Address Context
Overview
The address context is a container of objects that correspond to a specific IP
Addressing domain. Address contexts are used in SBC 5x00 to contain and
segregate objects that deal with IP addresses. For example, multiple IP interfaces
are grouped together into an IP interface group and all grouped IP interfaces are
going to use the same address context. The number of address contexts
supported by the system is 512.
The following diagram shows multiple IP interfaces and interface groups are
grouped together based on the address context.
FIGURE 3–1 Address Context Objects
It provides context to disambiguate overlapped addresses used in Signaling Ports, IP
Interfaces. The TCP and UDP port numbers (overlapping port numbers) as well as IP
addresses (overlapping addresses) can be re-used within each address context.
3–1
Address Context
Topics include:
•
•
•
•
•
•
•
•
•
•
3–2
"DNS Group" on page 3–3
"Intercept" on page 3–10
"IP Access Control List" on page 3–14
"IP Interface Group" on page 3–24
"IPsec" on page 3–32
"Link Detection Group" on page 3–42
"Link Monitor" on page 3–47
"Static Route" on page 3–62
"Zone" on page 3–65
"Request Commands" on page 3–115
DNS Group
Address Context
DNS Group
The DNS group object contains a list of DNS servers used to resolve SIP NAPTR,
SRV, A-record lookups.
The DNS server group is contained in an Address Context and is referenced by
Zones and SIP Trunk Groups in that Address Context.
The following diagram shows the DNS server group configuration.
FIGURE 3–2 DNS Server Group Configuration
Creating and Configuring DNS Servers
To create a DNS Server, use the command:
% set addressContext <addressContext> dnsGroup <dnsGroup>
localRecord <localRecord>
server <server>
type <type>
A maximum of eight (8) DNS servers can be created. The DNS Client sends the
query to the server with highest priority (lower value) first, and in case of a
timeout, the query is resent to the server with the next highest priority. For servers
with the same priority, the selection is distributed based on the weight value.
Priority and weight values are configurable. You can also configure recursion
preference (recursion involves assistance from other DNS servers to help resolve
the query).
3–3
Address Context
DNS Group
Command Syntax
// Mandatory parameters required to configure a DNS group.
To configure the type of IP interfaces to be used for this DNS Group:
% set addressContext <addressContext> dnsGroup <dnsGroup> type
<type>
To configure the local DNS resource record:
% set addressContext <addressContextname> dnsGroup <dnsGroup>
data <data>
hostName <hostName>
order <order>
state <state>
To configure the DNS server for this address context:
% set addressContext <addressContext> dnsGroup <dnsGroup>
server <server>
ipAddress <ipAddress>
priority <priority>
recursionDesired <false | true>
state <state>
weight <weight>
// Non-mandatory parameters that can be used to configure a DNS group.
To display the Local DNS resource record:
% show addressContext <addressContext> dnsGroup <dnsGroup>
server <server>
type <type>
To display the local DNS resource record:
% show addressContext <addressContextname> dnsGroup
<dnsGroup> localRecord <localRecord>
data <data>
hostName <hostName>
order <order>
state <state>
3–4
DNS Group
Address Context
To display the DNS server for this address context use the commands:
server <server>
priority <priority>
recursionDesired <false | true>
state <state>
weight <weight>
To configure and display the type of IP interfaces to be used for this DNS Group
use the commands:
ip interface
mgmt interface mgmtGroup
type <type>
% delete addressContext <addressContext> dnsGroup <dnsGroup>
% request addressContext <addressContext> dnsGroup <dnsGroup>
dnsServerReset
Command Parameters
TABLE 3–1
Parameter
DNS Group Parameters
Field
Length
Description
Mandatory parameter descriptions
addressContex 1-23
t
dnsGroup
1-32
Specifies the name of this DNS Group Entry. Must be 1-23
characters.
type
N/A
Specifies the type of IP interfaces to be used for this DNS
Group.
• ip
• mgmt
• none
3–5
Address Context
DNS Group
Parameter
Field
Length
Description
localRecord
N/A
Specifies the local DNS resource records.
• data - Specifies the DNS record data for this DNS record.
- ipAddress - Specifies the IPv4 or IPv6 address of the local
name service record data.
- priority - Specifies the local name service record data
priority. Must be 0-100.
- state - Specifies the administrative state of the local name
service record data. Options are:
disabled - Disables the administrative state of the local
record.
enabled - Enables the administrative state of the local
record.
- type - Specifies the local name service record data type.
• hostName - Specifies the host name of this local name
service record. The host name must be unique across all
records.
• order - Specifies the lookup order of this local name service
record. Options are:
- priority - Specifies the lookup order is according to the
record data entries' priority assignment.
- roundrobin - Specifies the lookup order is in a circular
round robin fashion.
• state - Specifies the state of this local name service record.
Options are:
- enabled - Enables the administrative state of the local
record.
- disabled (default) - Disables the administrative state of the
local record.
3–6
DNS Group
Address Context
Parameter
Field
Length
server
N/A
Description
Specifies the DNS server to be configured with in the DNS
group.
• ipAddress - Specifies the IPv4 or IPv6 address of this DNS
Server.
• priority - Specifies the priority of this DNS Server. Must be
0-100; default is 0.
• recursionDesired - Specifies whether recursion is desired
for the DNS Server. Select any one of the option false,
true.
• state - Specifies the Administrative state of DNS Server
configuration. Select any one of the option:
disabled - Disables the administrative state of the
DNS server.
enabled - Enables the administrative state of the DNS
server.
• weight - Specifies the load-sharing weight of this DNS
Server. Must be 0-100, default is 0.
Non-mandatory parameter descriptions
displaylevel 1-64
interface
N/A
commands.
Specifies the name of the Management Interface group
when using the management interfaces.
Command Examples
% set addressContext default dnsGroup dnsgrp33
% edit addressContext default dnsGroup dnsgrp33 interface
LIF1 localRecord 2 data 22 priority 2 state disabled type
a
% show addressContext default
dnsGroup DNS {
type none;
}
ipInterfaceGroup ipifgrp1 {
ipInterface ipif1 {
ceName
hornettest5;
portName
pkt0;
ipAddress 1.3.4.5;
3–7
Address Context
DNS Group
prefix
24;
}
}
ipAccessControlList {
rule Rule {
precedence
2;
protocol
any;
ipInterfaceGroup
ipifgrp1;
ipInterface
ipif1;
sourceIpAddress
0.0.0.0;
sourceAddressPrefixLength
0;
destinationIpAddress
0.0.0.0;
destinationAddressPrefixLength 0;
sourcePort
any;
destinationPort
any;
action
accept;
fillRate
unlimited;
bucketSize
unlimited;
state
disabled;
}
}
To display DNS group details with display level set to 1:
% show addressContext default dnsGroup dns_s displaylevel 1
type
mgmt;
interface
mgmtGroup;
localRecord LOC;
To display DNS group details with display level set to 5:
% show addressContext default dnsGroup dns_s displaylevel 5
type
mgmt;
interface
mgmtGroup;
localRecord LOC {
data 4 {
type
a;
priority
5;
ipAddress 10.20.30.121;
state
enabled;
}
hostName HOST;
3–8
DNS Group
Address Context
}
Configuring DNS A/SRV and NAPTR Queries
The SBC 5x00 supports DNS A/SRV and NAPTR Queries. The DNS Group and
DNS support type configuration is required in the SBC 5x00 to trigger the DNS
Queries to the DNS Server.
Perform the following to configure the DNS server:
1. Create a DNS group and add the DNS server in the group. You can also add
more than one server and it will be selected based on the weight and the
priority.
%set addressContext a1 dnsGroup <dnsgroupname> server
<servername> ipAddress <DNS ipaddress> state enabled
2. In the SIP Trunk Group services, create a Static route for the DNS Server.
%set addressContext a1 zone <zone name> sipTrunkGroup
<trunkgrp name> services dnsSupportType a-srv-naptr
% set addressContext a1 staticRoute <dns ip address>
<prefix> <gateway ip> <LIFx> <lif_ethx> preference 10
3. Make sure that IP Peer returns the domain name so that SBC 5x00 can send
the query to the DNS Server.
% set addressContext a1 zone <dnsgroupname> ipPeer <peer
name> policy sip fqdn <Domain name> fqdnPort <port>
4. Check the DNS server status and statistics:
% show table/status addressContext a1 dnsGroup DNSGroup1
dnsServerStatistics
dnsEntryStatus
dnsEntryDataStatus
3–9
Address Context
Intercept
Intercept
The Sonus SBC 5x00 supports Lawful Intercept (LI) functionality. Sonus SBC
5x00 works in coordination with an Intercept Server (IS) to provide call data and
call content to law enforcement agencies for calls involving identified intercept
subjects. When it receives matching LI criteria in a policy response from the PSX,
the SBC 5x00 routes the call as directed and additionally reports call events to the
IS. It also sends an RTP copy of the call’s voice streams (call content) to an IP
address provided by the IS.
NOTE
You can configure the LI only with default AddressContext.
Command Syntax
Use the following commands to configure LI:
% set addressContext <default> intercept
callDataChannel <callDataChannel>
nodeNumber <nodeNumber>
Use the following command to retrieve the LI call data channel configuration:
% set addressContext <default> intercept callDataChannel
<callDataChannel>
ipInterfaceGroupName <ipInterfaceGroupName>
kaTimer <kaTimer>
priIpAddress <priIPAddress>
priMode <priMode>
priPort <priPort>
priState <priState>
retries <retries>
secipaddress <secipaddress>
secMode <secMode>
secState <secState>
Use the following command to retrieve the LI statistics:
3–10
Intercept
Address Context
% show status addressContext <default> intercept
interceptCallDataChannelStatistics
<interceptCallDataChannelStatistics>
Command Parameters
TABLE 3–1
Intercept Parameters
Parameter
Field
Length
default
1-23
Description
The address context is a container of objects that
correspond to a specific IP Addressing domain. Must be 123 characters.
CallDataChann NA
el
Specifies the user configured LI Call Data Control Channel.
NA
Specifies the global unique node number for the SBX used by the
LI Server for ID.
ipInterfaceGr NA
oupName
Specifies the name of the IP interface group used to stream
to the LI Server.
nodeNuber
kaTimer
NA
Specifies the Keep Alive Timer in seconds.
priIpAddress
NA
Specifies the primary LI Server's IP address where Call
Data Channel messages are sent.
priMode
NA
Specifies the mode of the primary server. Options are:
• active
• standby
• out of service
priPort
NA
Specifies the primary LI Server's UDP port where Call Data
Channel messages are sent.
pristate
NA
Specifies if the communication to the primary LI Server is
enabled or not. Options are:
• enabled
• disabled
retries
NA
Specifies the number of retries before the LI Call Data
Channel is considered as failed.
secipaddress
NA
Specifies the secondary LI Server's IP address where Call
Data Channel messages are sent.
3–11
Address Context
Intercept
TABLE 3–1
Intercept Parameters
Parameter
Field
Length
Description
secMode
NA
Specifies the mode of the secondary server. Options are:
• active
• standby
• out of service
secState
NA
Specifies if the communication to secondary LI Server is
enabled or not. Options are:
• enabled
• disabled
3–12
Intercept
Address Context
Command Examples
% show status addressContext default intercept
interceptCallDataChannelStatistics
interceptCallDataChannelStatistics default
{
primaryChannelStatus
InService;
secondaryChannelStatus outOfService;
StartSuccess
7967;
StartFailures
0;
StopSuccess
7967;
StopFailures
0;
CallAnswerSuccess
7929;
CallAnswerFailures
0;
CallDisconnectSuccess
7965;
CallDisconnectFailures 0;
ServiceInstanceSuccess 0;
ServiceInstanceFailures 0;
IndicationSuccess
185;
IndicationFailures
0;
KeepAliveSuccess
665;
KeepAliveFailures
0;
RestartSuccess
1;
RestartFailures
0;
RadiusAckReceived
53064;
StartResponsesReceived 7967;
}
3–13
Address Context
IP Access Control List
IP Access Control Lists (IP ACLs) are the packet filtering objects that are applied
to incoming IP packets on the SBC 5x00. These objects protect the system from a
variety of network-borne attacks.
Use IP ACLs to specify rules to permit or deny packets into the SBC 5x00. The IP
ACL can optionally pass the traffic but at only a certain policed rate.
NOTE
When a user creates a new management group the user must add user
defined ACL rules to get the equivalent rules that are set up for the
default management group.
Command Syntax
// Mandatory parameters required to configure an IP Access Control List.
% set addressContext <addressContext> ipAccessControlList
rule <rule>
action <action>
bucketSize <bucketSize>
destinationAddressPrefixLength
<destinationAddressPrefixLength>
destinationIpAddress <destinationIpAddress>
destinationPort <destinationPort>
fillRate <fillRate>
precedence <precedence>
protocol <protocol>
sourceAddressPrefixLength <sourceAddressPrefixLength>
sourceIpAddress <sourceIpAddress>
sourcePort <sourcePort>
state <state>
// Non-mandatory parameters that can be used to configure an IP Access Control
List.
% set addressContext <addressContext> ipAccessControlList
rule <rule>
ipInterface <ipInterface>
ipInterfaceGroup <ipInterfaceGroup>
3–14
Address Context
mgmtIpInterface <mgmtIpInterface>
mgmtIpInterfaceGroup <mgmtIpInterfaceGroup>
% show addressContext <addressContext> ipAccessControlList
rule <rule>
% show addressContext <addressContext> ipAccessControlList
rule <rule>
action <action>
bucketSize <bucketSize>
destinationAddressPrefixLength
<destinationAddressPrefixLength>
destinationPort <destinationPort>
fillRate <fillRate>
ipInterfaceGroup <ipInterfaceGroup>
mgmtIpInterfaceGroup <mgmtIpInterfaceGroup>
protocol <protocol>
sourceAddressPrefixLength <sourceAddressPrefixLength>
sourcePort <sourcePort>
state <state>
% delete addressContext <addressContext> ipAccessControlList
<rule>
Command Parameters
TABLE 3–2
Parameter
IP Access Control List Parameters
Field
Length
Description
addressContex 1-23
t
3–15
Address Context
TABLE 3–2
Parameter
Field
Length
Description
rule
N/A
Specifies the name of this access control list rule.
Each rule is defined with a precedence that is unique within
an Address Context. This precedence value determines
the order in which the rules are loaded and executed for
each incoming packet.
If an incoming packet matches two identical rules, then IP
ACL rule with the highest precedence will be applied for
that incoming packet.
action
N/A
Specifies the action to take when this rule is matched. The
values are:
• accept - Incoming packets matching this ACL rule are
accepted into the system.
• discard - Incoming packets matching this ACL rule are
discarded (not allowed into the system).
bucketSize
1-255
Specifies the policing bucket size in packets. The values
are:
• 1-255
• unlimited - Select unlimited for continuous policing.
destinationAd 1-128
dressPrefixLe
ngth
Specifies the length of destination IP address prefix which
must match the protocol.
destinationIp N/A
Address
Specifies the destination IPv4 address prefix to match. The
default value is 0.0.0.0. Valid value can be any valid IPv4
address.
destinationPo N/A
rt
Specifies the destination port to match.
fillRate
1-255
For IPv4, the length is in the range of 0 to 32.
• any
Specifies the policing fill rate. The fill rate is in packets/
second.
• 1-10000
• unlimited (default) - Select unlimited for continuous fill rate.
precedence
1-65535 Specifies the precedence of this access control list rule.
Each IP ACL rule must have a unique precedence value to
apply the rule in the proper order. Default value is 10.
3–16
TABLE 3–2
Address Context
Parameter
Field
Length
protocol
N/A
Description
Specifies the IP protocol type that will be a criterion of the
IP input match:
•
•
•
•
•
•
any (default) - filter all protocols
icmp - filter ICMP only
icmpv6 - filter ICMPv6 only
ospf - filter OSPF only
tcp - filter TCP only
udp - filter UDP only
These protocols are typically associated with particular
logical port values.
sourceAddress 0-32
PrefixLength
Specifies the length of source IP address prefix which must
match the protocol.
For IPv4, the length is in the range of 0 to 32.
sourceIpAddre N/A
ss
sourcePort
N/A
Specifies the source IP address to match. The default
value is 0.0.0.0. Valid value can be any valid IPv4 address.
Specifies the source port to match.
• any
state
N/A
Specifies the administrative state of the IP access control
list rule.
• enabled - All incoming packets are matched against this ACL
rule.
• disabled (default) - The ACL rule is not used for any
incoming packet matching.
ipInterface
N/A
Specifies the name of an IP interface. Enter IP interface or
select any to match any IP interface.
ipInterfaceGr N/A
oup
Specifies the name of an IP interface group. Enter IP
interface group or select any to match any IP interface
group.
mgmtIpInterf N/A
ace
Specifies the name of a MGMT IP interface to match, or
"any" to match any MGMT IP interface.
mgmtIpInterf N/A
aceGroup
Specifies the name of a MGMT IP interface group to match
or "any" to match any MGMT IP interface group.
displaylevel 1-64
commands.
3–17
Address Context
Command Examples
% set addressContext default ipAccessControlList rule 2
action accept bucketSize unlimited
destinationAddressPrefixLength 2 destinationIpAddress
10.34.25.153 destinationPort any fillRate 33 ipInterface
ipInterface1 ipInterfaceGroup ipInterfaceGroup1
precedence 22 protocol any sourceAddressPrefixLength 1
sourceIpAddress 10.32.22.145 sourcePort any state
disabled
% show addressContext default ipAccessControlList
rule 2 {
precedence
22;
protocol
any;
ipInterfaceGroup
ipInterfaceGroup1;
ipInterface
ipInterface1;
sourceIpAddress
10.32.22.145;
1;
10.34.25.153;
sourcePort
any;
destinationPort
any;
action
accept;
fillRate
33;
bucketSize
unlimited;
state
disabled;
}
To display the IP access control list details with display level set to 1:
displaylevel 1
rule RULE1;
rule rule1;
To display the IP access control list details with display level set to 3:
displaylevel 3
rule RULE1 {
precedence 4;
}
rule rule1 {
precedence
3–18
1;
Address Context
protocol
any;
sourceIpAddress
0.0.0.0;
0;
0.0.0.0;
sourcePort
any;
destinationPort
any;
action
accept;
fillRate
unlimited;
bucketSize
unlimited;
state
disabled;
}
To view the configured rules and precedence:
% show table addressContext default ipAccessControlList rule
% show table addressContext default ipAccessControlList
ipAclRulesByPrecedence
To view statistics:
ipAclOverallStatistics
% show table addressContext a1 ipAccessControlList
ipAclRuleStatistics
If using a management interface group other than the default one, adding a set of
ACL rules as shown below will replicate the defaulted ACL rules the system
provides for the default management interface group. In this case a
management interface group mgmtGroup1 has been previously created.
set addressContext default ipAccessControlList rule mgmt2_22
destinationPort 22 mgmtIpInterfaceGroup mgmtGroup1 protocol
tcp bucketSize 10 fillRate 100 precedence 200 action accept
state enabled
set addressContext default ipAccessControlList rule mgmt2_80
destinationPort 80 mgmtIpInterfaceGroup mgmtGroup1 protocol
tcp bucketSize 10 fillRate 100 precedence 201 action accept
state enabled
3–19
Address Context
set addressContext default ipAccessControlList rule
mgmt2_161 destinationPort 161 mgmtIpInterfaceGroup
mgmtGroup1 protocol udp bucketSize 10 fillRate 50 precedence
202 action accept state enabled
mgmt2_123 sourcePort 123 mgmtIpInterfaceGroup mgmtGroup1
protocol udp bucketSize 4 fillRate 4 precedence 103 state
enabled
enabled
enabled
mgmtGroup1 protocol tcp bucketSize 10 fillRate 10 precedence
206 action accept state enabled
mgmtGroup1 protocol tcp bucketSize 10 fillRate 100
precedence 208 action accept state enabled
mgmtGroup1 protocol tcp bucketSize 250 fillRate 2500
precedence 209 action accept state enabled
protocol udp bucketSize 250 fillRate 1200 precedence 110
state enabled
To display the configured IP ACL details:
show table addressContext default ipAccessControlList rule
SOURCE
3–20
DESTINATION
Address Context
IP
MGMT IP
SOURCE
ADDRESS
ADDRESS
DESTINATION
NAME
INTERFACE IP
SOURCE DESTINATION
PREFIX
PRECEDENCE
ADDRESS
LENGTH
PROTOCOL
PORT
GROUP
PORT
INTERFACE
MGMT IP
FILL BUCKET
INTERFACE GROUP
ACTION RATE
SIZE
INTERFACE
STATE
IP
PREFIX
ADDRESS
LENGTH
IP
-------------------------------------------------------------------------------------------------------------------mgmt2_22
0
200
mgmt2_80
0
201
mgmt2_123
0
103
mgmt2_161
0
202
mgmt2_162
0
104
mgmt2_443
0
208
mgmt2_1812
0
105
mgmt2_1813
0
110
mgmt2_2022
0
206
mgmt2_2024
0
209
tcp
any
-
tcp
any
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
100
accept
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
100
accept
mgmtGroup1 4
enabled
0.0.0.0
0
0.0.0.0
4
accept
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
50
accept
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
10
accept
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
100
accept
mgmtGroup1 4
enabled
0.0.0.0
0
0.0.0.0
4
-
accept
mgmtGroup1 1200 250
enabled
0.0.0.0
0
0.0.0.0
-
accept
mgmtGroup1 10
enabled
0.0.0.0
0
0.0.0.0
10
accept
mgmtGroup1 2500 250
enabled
0.0.0.0
0
0.0.0.0
80
udp
123
any
udp
any
161
udp
162
any
tcp
any
443
udp
1812
any
udp
1813
any
tcp
any
2022
tcp
any
accept
22
2024
To view the default system IP ACL statistics:
defaultIpAclStatistics
NOTE
The system ACLs are displayed only for default AddressContext.
addressContextID <addressContextID>
application <application>
BucketSize <BucketSize>
CreditRate <CreditRate>
lifgrpID <lifgrpID>
packetAccept <packetAccept>
packetDiscard <packetDiscard>
PolID <polID>
polPriority <polPriority>
3–21
Address Context
policingMode <policingMode>
protocol <protocol>
TABLE 3–3
Default IP Access Control List Parameters
Parameter
Field
Length
addressContex NA
tID
Description
Displays the address context ID of the ACL rule.
application
NA
Displays the application that uses the ACL rule.
BucketSize
NA
Displays the policer bucket size.
CreditRate
NA
Displays the allowed packet rate.
destinationIp NA
Address
Displays the destination IP address, Port Number and
Prefix length.
lifGrpID
NA
Displays the management group ID.
packetAccpet
NA
Displays the number of packets accepted by the rule.
packetDiscard NA
Displays the number of packets discarded by the rule.
polID
NA
Displays the aggregator policer ID.
polPriority
NA
Displays the aggregator policer priority.
policingMode
NA
Displays the policing mode in packets per second.
protocol
NA
Displays the type of protocol used by the policer.
sourceIpAddre NA
ss
3–22
Displays the source IP address, Port Number and Prefix
length.
Address Context
FIGURE 3–3 Default System IP ACL Statistics
3–23
Address Context
IP Interface Group
IP Interface Group
IP Interface Groups are a primary tool for accomplishing disjoint networks
(administrative network separation). An IP Interface Group is the local
manifestation of a segregated network domain.
NOTE
The IP Interface on the media ports 0 and 1 is considered as first set
(example: set 1) and the IP Interfaces on media ports 2 and 3 is
considers as the second set (Example: set 2).
While associating the interfaces to an IP Interface Group, the IP
Interfaces associated to the group must be from the same set (set 1 or
set 2). This should be set at the configuration level.
Command Syntax
// Mandatory parameters required to configure an IP Interface Group.
% set addressContext <addressContext> ipInterfaceGroup
<ipInterfacegroup> ipInterface <ipInterface>
action <action>
bandwidth <bandwidth>
bwContingency <bwContingency>
ceName <ceName>
dryupTimeout <dryupTimeout>
mode <mode>
portName <portName>
prefix <prefix>
state <state>
<ipInterfacegroup> ipsec <enable | disable>
// Non-mandatory parameters that can be used to configure an IP Interface Group.
altIpAddress <altIpAddress>
altPrefix <altPrefix>
3–24
IP Interface Group
Address Context
vlanTag <vlanTag>
% show addressContext <addressContext> ipInterfaceGroup
<ipInterfacegroup>
ipsec
action <action>
altIpAddress <altIpAddress>
altPrefix <altPrefix>
bandwidth <bandwidth>
bwContingency <bwContingency>
ceName <ceName>
dryupTimeout <dryupTimeout>
mode <mode>
portName <portName>
prefix <prefix>
state <state>
vlanTag <vlanTag>
<ipInterfacegroup> ipsec displaylevel <displaylevel>
% delete addressContext <addressContext> ipInterfaceGroup
Command Parameters
TABLE 3–4
Parameter
IP Interface Group Parameters
Field
Length
Description
3–25
Address Context
TABLE 3–4
IP Interface Group
IP Interface Group Parameters (Continued)
Parameter
Field
Length
Description
addressContex 1-23
t
ipInterfaceGr 1-23
oup
Specifies a group of IP interfaces for the specified address
context. Must be 1-23 characters.
SBC 5x00 supports sharing of IP address by media and the
signaling objects. In order to share media and signaling by
same IP address, both IP interfaces must belong to same
IP interface group.
ipInterface
1-23
Specifies the IP interface name. Must be 1-23 characters.
NOTE
SBC 5x00 supports maximum of
4096 IP interfaces.
action
1-2
Specifies the dryup option for IP interface. The dryup
options are
• dryUp
• force
bandwidth
N/A
Specifies the maximum amount of bandwidth allowed in
units of bytes or seconds for this IP interface. Must be 02147483647 as follows:
• 0 - Allow bandwidth subscriptions up to the maximum
supported on the physical port.
• non-zero - Allow up to the specified number of bytes per
second on this IP interface. The aggregate of this number and
all previously provisioned IP interfaces must not exceed the
physical port bandwidth.
bwContingency N/A
Specifies the percentage of maximum bandwidth that is
reserved for contingency (that is, non-media). Must be 0100 percent.
The maximum bandwidth is the bandwidth normally
available for media on the interface. (This is based on the
configured bandwidth limit or the physical port bandwidth
limit minus approximately 5% for signaling traffic.) The
contingency factor effectively reserves a portion of this
bandwidth for non-media.
3–26
IP Interface Group
TABLE 3–4
Address Context
Parameter
Field
Length
ceName
1-255
Description
Specifies the name of the compute element that hosts the
port used by this IP interface. Must be 1-255 characters.
NOTE
ceName identifies each node
(active or standby). System name
identifies the HA pair. SBC 5x00
is deployed in 1:1 redundancy
(active or standby).
dryupTimeout
N/A
Specifies the dryup timeout in minutes. The number of
minutes to wait for active calls to complete before dropping
the call. Must be 1-1440, default is 10.
ipAddress
N/A
Specifies the primary IP Address of the Interface. The
following IP address types are supported:
example 128.127.50.224).
• IPv6 - This is V6 IP address in hexadecimal/colon form (for
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
In general, this parameter should not be set on the NIF or
IP interface and you should configure the next hop IP
address as part of a static route. This static route may be a
default static route or a more specific static route to the call
destination IP address that specifies the next hop router IP
address.
mode
N/A
Specifies the operational mode of the NIF:
• inService (default) - This state is set by default when state
is enabled.
• outOfService - Set this state before changing state to
disabled.
3–27
Address Context
TABLE 3–4
IP Interface Group
Parameter
Field
Length
portName
N/A
Description
Specifies the physical port name used by this IP interface.
Supported physical port names are:
• mgmt0 - Primary Management Ethernet port for OAM.
• mgmt1 - Secondary Management Ethernet port for OAM.
• pkt0 - First Gigabit Ethernet port used for signaling and media
traffic.
• pkt1 - Second Gigabit Ethernet port used for signaling and
media traffic.
• pkt2 - Third Gigabit Ethernet port used for signaling and
media traffic.
• pkt3 - Fourth Gigabit Ethernet port used for signaling and
media traffic.
NOTE
ipInterfaceGroup and
ipInterface should not be
configured for mgmt0 and mgmt1
ports. You can configure mgmt0
and mgmt1 ports with
mgmtIpInterfaceGroup and
mgmtIpInterface.
NOTE
Packet ports (pkt) identify the
physical ports used for signaling
and media. Media ports are UDP
ports used to carry media traffic.
prefix
N/A
Specifies the IP subnet prefix of this Interface. Must be 0128. Default value is 16.
state
N/A
Specifies the administrative state of the network interface.
• disabled (default) - in this state the IP interface is inactive, it
does not respond to a ping.
• enabled - in this state the IP interface is active and it
responds to a ping if the Ethernet cable is plugged in.
3–28
IP Interface Group
TABLE 3–4
Address Context
Parameter
Field
Length
altIpAddress
N/A
Description
Specifies alternative (secondary) IP address for the
configured packet IP interface. The alternative IP address
is optional.
The following IP address types are supported:
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
NOTE
Modify an alternative IP address
only after changing the Packet IP
interface to disabled state.
altPrefix
N/A
Specifies the alternative IP subnet prefix of this interface. It
must be between 0-128.
vlanTag
N/A
Specifies the VLAN TAG assigned to this physical interface.
displaylevel 1-64
commands.
Command Example
To display configuration information regarding all IP interfaces:
% show addressContext default ipInterfaceGroup
addressContext default {
ipInterfaceGroup LIF1 {
ipInterface lif_eth2 {
ceName
merc;
portName
pkt0;
ipAddress 10.34.25.151;
prefix
24;
altPrefix 33;
mode
inService;
state
enabled;
}
}
ipInterfaceGroup LIF2 {
3–29
Address Context
IP Interface Group
ipInterface lif_eth3 {
ceName
merc;
portName
pkt1;
ipAddress 10.34.26.153;
prefix
24;
mode
inService;
state
enabled;
}
}
To display configuration information regarding all IP interfaces with display level
set to 3:
% show addressContext default ipInterfaceGroup displaylevel
3
ipInterfaceGroup ipinterface {
ipsec disabled;
ipInterface ipinterface;
}
To display configuration information regarding all IP interfaces with display level
set to 5:
% show addressContext default ipInterfaceGroup displaylevel
5
ipInterfaceGroup ipinterface {
ipsec disabled;
ipInterface ipinterface {
ceName
sbx30;
portName
mgmt0;
ipAddress
1.2.3.4;
prefix
1;
altIpAddress
2001:DB8:85A3::8A2E:370:7334;
altPrefix
3;
action
dryUp;
dryupTimeout
60;
bwContingency 0;
3–30
vlanTag
2;
bandwidth
1;
IP Interface Group
Address Context
}
}
To display interface status:
% show table addressContext a1 ipInterfaceGroup IFG-INT
ipInterfaceStatus
ACTUAL
NAME
RX
TX
NUM
ALLOCATED
PACKETS
PACKETS
CALLS
BANDWIDTH
BW
IFINDEX OPER STATE
BANDWIDTH DEVIATION
OOS REASON
------------------------------------------------------------------------------------------------------lif_eth1 13
resAllocated notApplicable 45868143
55265010 0
0
0
0
3–31
Address Context
IPsec
IPsec
The Sonus IP Security package (IPsec) provides cryptographic protection for SIP
signaling and other non-media IP traffic (for more information, refer to "Signaling"
on page 6–115).
Sonus IPsec operates in tunnel mode rather than transport mode. In tunnel mode,
the entire packet is encrypted and authenticated. In transport mode, only the
packet payload is encrypted and authenticated.
A single IP SECURITY POLICY instance is created and assigned to the IP
interfaces being used for signaling.
The IP SECURITY POLICY contains the following databases:
•
•
•
Security Policy Database (SPD) - An ordered list of “rules”, built and
configured by operators, that specify the type of protection to provide for each
packet that is subjected to the rule.
Internet Key Exchange (IKE) Peer Database (IPD) - A list of peer devices,
built and configured by operators, that defines eligibility and authentication
data for protected sessions using IPsec.
Security Association Database (SAD) - The list of active Security
Associations (SAs) that have been created from successful IPsec negotiations
between SBC 5x00 and the protectable peers. Each SA is the bundle of
algorithms and parameters that is used to encrypt and authenticate a
particular flow in one direction. Thus for normal bi-directional traffic, the flows
are secured by a pair of security associations. This list is system, rather than
operator, generated.
Each SPD entry (or rule) identifies local and remote peer transport addresses that
it may be applied to. This entry also establishes three packet protection actions:
•
•
•
Discard - discard the packet
Bypass - pass the packet on without modification
Protect - encrypt the packet according to an encryption algorithm that has
been mutually agreed to by the session peers
The SPD entry PRECEDENCE establishes that entry’s order, relative to other
entries, from 1 to 65535. Each SPD entry references up to three IPsec Protection
Profiles that specify an encryption cipher, a maximum time period for maintaining
a security association between these peers (the SA “lifetime”), and an antireplay
policy. The three profiles are prioritized from one to three for usage with the SPD
entry.
Each IPD entry specifies a remote peer address to use for a protected session.
The IPD entry also contains a PRESHARED SECRET (text string), and local and
remote identification information. These parameters are all used in the peer-topeer authentication process. As with SPD entries, IPD entries also reference up to
three (3) prioritized IKE Protection Profiles. The IKE profiles specify an encryption
cipher, a maximum time period for maintaining security associations, and
abandon-session-because-of-error policies. These profiles are also prioritized
from 1 to 3 for usage with the IPD entry.
3–32
IPsec
Address Context
An IPsec SA is the result of a successful two stage negotiation between the SBC
5x00 and a peer. The phase 1 negotiation achieves a (bidirectional) IKE SA. The
IKE SA provides a channel over which the two peers carry out a phase 2
negotiation. The successful completion of a phase 2 negotiation achieves an
IPsec SA pair (two unidirectional SAs) that the peers may use to protect IP traffic
between them until the IPsec SA expires or is removed.
In the IKE phase 1 exchange, the PRESHARED SECRET is used by the peers to
authenticate one another. In the IKE phase 2 exchange, the packet selectors, the
encryption cipher, the integrity cipher, and the SA lifetime are negotiated. If there
is a valid intersection between the peers for all of these parameter values, then
the phase 2 negotiation is successful and an IPsec SA will result.
When the negotiation is initiated by the peer, the SBC 5x00 behaves as a
responder. When SBC 5x00 initiates the negotiation, it is the active participant in
the exchange.
When SBC 5x00 is participating as a responder, an initial IKE message from the
peer causes SBC 5x00 to access the IPD to find an entry that enables the
authentication of a session between the peers. After a successful IKE phase 1
negotiation, a subsequent (phase 2) proposal from the peer causes SBC 5x00 to
search the SPD to find an entry with parameter values that overlap those values
proposed by the peer. The parameter values in this SPD entry that are common to
this entry as well as those proposed by the peer, are offered to the remote peer,
as a counter proposal. If the peer accepts this counter proposal, then the IKE
phase 2 negotiation is successful and an IPsec SA pair that defines a protection
scheme for packets flowing between the SIP peer and SBC 5x00 is established.
When SBC 5x00 is acting as an initiator, an outgoing SIP message from SBC
5x00 causes the SPD search. The SPD entry that is consequently selected points
to a linked IPD entry (identifying the IKE peer) with which to pursue IKE phase 1
and phase 2 negotiations. The successful completion of these negotiations again
results in an IPsec SA pair that defines the protection scheme for packets flowing
between SBC 5x00 and the SIP peer.
You may remove SAs, before their lifetime expires, in the following ways:
•
•
•
globally delete every IKE SA (delete .. all)
delete a specific IKE SA by its IKE handle identifier (delete .. ike id
..)
delete the IPsec SA pair with a given local tunnel IP address (local tunnel
ip address) and a given incoming Security Parameter Index value (local
spi).
SAs may also be removed through notification by the peer that an SA is deleted, or
as a result of Dead Peer Detection determining that a peer is unresponsive.
If an SA is deleted by one of the above scenarios within 60 seconds of the time
that it was initially established, then as a Denial-of-Service protection, the SBC
5x00 will not respond to new phase 1 IKE negotiations initiated by that peer for 60
seconds. Otherwise, phase 1 IKE re-negotiations may proceed immediately on a
deleted SA.
You may display the configuration, status, and statistics that pertain to all of these
objects.
3–33
Address Context
IPsec
Command Syntax
// Mandatory parameters that are required to configure the IPSec.
% set addressContext <addressContext> ipsec peer <peer>
preSharedKey <preSharedKey>
protocol <protocol>
% set addressContext <addressContext> ipsec spd <spd>
action <action>
localIpAddr <localIpAddr>
localIpPrefixLen <localIpPrefixLen>
localPort <localPort>
protocol <protocol>
remoteIpAddr <remoteIpAddr>
remoteIpPrefixLen <remoteIpPrefixLen>
remotePort <remotePort>
state <state>
// Non-manadatory parameters that can be used to configure the IPSec.
% set addressContext <addressContext> ipsec peer <peer>
localIdentity <localIdentity>
protectionProfile <protectionProfile>
remoteIdentity <remoteIdentity>
% show addressContext <addressContext> ipsec
peer <peer>
spd <spd>
% show addressContext <addressContext> ipsec peer <peer>
localIdentity <localIdentity>
domainName <domainName>
type <type>
preSharedKey <preSharedKey>
3–34
IPsec
Address Context
protectionProfile <protectionProfile>
protocol <protocol>
remoteIdentity <remoteIdentity>
% show addressContext <addressContext> ipsec spd <spd>
action <action>
bypass
discard
protect
localIpAddr <localIpAddr>
localIpPrefixLen <localIpPrefixLen>
localPort <localPort>
protocol <protocol>
remoteIpAddr <remoteIpAddr>
remoteIpPrefixLen <remoteIpPrefixLen>
remotePort <remotePort>
state <state>
% delete addressContext <addressContext> ipsec peer <peer>
% delete addressContext <addressContext> ipsec spd <spd>
% request addressContext <addressContext> ipsec
ikeSaDelete <ikeSaDelete>
ikeSaDeleteAll <ikeSaDeleteAll>
ipsecSaDelete <ipsecSaDelete>
3–35
Address Context
IPsec
Command Parameters
TABLE 3–5
IPsec Peer Parameters
Field
Length
Parameter
Description
Mandatory peer parameter descriptions for IPSec
addressContex 1-23
t
NOTE
IPSec is only supported in
default address context.
1-23
peer
Specifies the name of the Internet Key Exchange (IKE)
peer database entry. This name identifies an entry in the
IKE Peer Database (IPD). The IPD is a list of remote
devices that may become IPsec peers.
The IPD establishes the authentication and other phase 1
criteria for the peer-to-peer negotiation to eventually reach
an IKE Security Association (SA) between this specific
peer and the SBC.
ipAddress
N/A
Specifies the IPv4 or IPv6 address of the peer.
preSharedKey
1-128
Specifies the Pre-shared Secret with this peer. A string of
from 1 to 128 case-sensitive, alphanumeric characters.
These characters may only be in the range 0-9, a-z, space,
and A-Z. Alternatively, a hexadecimal value introduced by
"0x" and followed by 1 to 126 hexadecimal digits (0-9, a-f,
A-F). In either case the given value represents a “pre
shared secret” between the SBC 5x00 and the IKE peer.
This value is used for mutual authentication for phase 1
negotiation to set up an IKE Security association.
Sonus strongly recommends that you use a unique,
unpredictable secret value using a random string of 30 or
more characters. This value should differ for each IKE
peer.
This string is never revealed in clear by any of the show
commands.
protocol
N/A
Specifies the key management protocol used to exchange
with this peer.
• ikev1 - Internet Key Version 1.
Non-mandatory peer parameter descriptions for IPSec
3–36
IPsec
TABLE 3–5
Parameter
Address Context
IPsec Peer Parameters (Continued)
Field
Length
localIdentity N/A
Description
Specifies the localIdentity that SBC 5x00 will assert to
the peer during phase 1 authentication. Select type and
specify any one of the following local identity:
• fqdn - Specifies that the local identity will be presented in
Fully Qualified Domain Name (FQDN) format, taking as its
value the FQDN of the SBC 5x00, specified by the next
argument such as westford.example.com.
- domainName - Specifies the domain name string
specifying ike peer identity in FQDN format.
• ipV4Addr - Specifies that the local identity will be presented
in IPv4 address format, taking as its value the IP address of
the SBC 5x00 specified by the next argument.
- ipAddress - Enter the IPv4 address.
• ipV6Addr - Specifies that the local identity will be presented
in IPv6 address format, taking as its value the IP address of
the SBC 5x00 specified by the next argument.
• ipVxAddr - Specifies that the local identity will be presented
as ID of type ID_IPVx_ADDRESS, taking as its value being
the IPsec termination address in use for the current
negotiation.
3–37
Address Context
TABLE 3–5
IPsec
IPsec Peer Parameters (Continued)
Parameter
Field
Length
protectionPro N/A
file
remoteIdentit
y
N/A
Description
Specifies the name of the ike protection profile to be
applied to the Key management protocol exchange with
this peer.
Specifies the positional index of the route entry in the
routing table.
Specifies the remote Identity that SBC 5x00 will assert to
the PEER during phase 1 authentication. Select type and
specify any one of the following remote identity:
• fqdn - Specifies that the remote identity will be presented in
Fully Qualified Domain Name (FQDN) format, taking as its
value the FQDN of the SBC 5x00, specified by the next
argument such as westford.example.com.
- domainName - Specify the domain name string
specifying ike peer identity in FQDN format.
• ipV4Addr - Specifies that the remote identity will be
presented in IPv4 address format, taking as its value the IP
address of the SBC 5x00 specified by the next argument. This
is V4 IP address in dotted decimal form (for example
128.127.50.224).
• ipV6Addr - Specifies that the remote identity will be
presented in IPv6 address format, taking as its value the IP
address of the SBC 5x00 specified by the next argument. This
is V6 IP address in hexadecimal/colon form (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
3–38
IPsec
TABLE 3–6
Address Context
IPsec spd Parameters
Parameter
Field
Length
Description
Mandatory SPD parameter descriptions for IPSec.
addressContex 1-23
t
1-23
spd
Specifies the name of an IPsec Security Policy Database
(SPD) entry. The IPsec SPD is an ordered list of entries
(“rules”) that specify sets of packets and determine
whether or not to permit, deny, or protect packets between
the SBC 5x00 and the peer that is referenced from the
entry. If the packets are to be protected, this entry
references information that specifies how to protect them.
The SPD establishes the phase 2 criteria for the
negotiation between the SBC 5x00 and the IKE peer. The
successful completion of this negotiation results in a
Security Association (SA).
You may create and configure up to 4096 SPD entries.
action
N/A
Specifies the action applied when packets processed by
IPSEC found matching the selectors of this SPD rule.
• Discard – Specifies that the packets are dropped.
• Bypass – Specifies that the packets are bypassed as clear
text.
• Protect – Specifies that the packets are protected by IPSEC
based on the protection parameters specified in the
configured ipsec protection profile.
localIpAddr
N/A
localIpPrefix 0-128
Len
Specifies the local IPv4 or IPv6 address of the SPD traffic
selector.
Specifies the local IP prefix length of the SPD traffic
selector. Default value is 0.
localPort
0-65535 Specifies the local port of the SPD traffic selector. Zero
indicates wildcard. Default value is 0.
precedence
0-65535 Specifies the evaluation order of this entry. Zero indicates
wildcard.
protocol
0-255
Specifies the IP protocol number of the SPD traffic selector.
Zero indicates wildcard. Default value is 0.
remoteIpAddr
N/A
Specifies the remote IPv4 or IPv6 address of the SPD
traffic selector. Zero indicates wildcard.
remoteIpPrefi 0-128
xLen
remotePort
Specifies the remote IP prefix length of the SPD traffic
selector. Zero indicates wildcard. Default value is 0.
0-65535 Specifies the remote port of the SPD traffic selector. Zero
indicates wildcard. Default value is 0.
3–39
Address Context
TABLE 3–6
IPsec
IPsec spd Parameters (Continued)
Parameter
Field
Length
state
N/A
Description
Specifies the administrative state to disable or enable a
SPD entry. Zero indicates wildcard.
displaylevel 1-64
commands.
Command Example
To display the IPsec Policy details with display level set to 3:
% show addressContext ipsec displaylevel 3
ipsec {
peer PEER1;
}
To display the IPsec Policy details with display level set to 5:
% show addressContext ipsec displaylevel 5
ipsec {
peer PEER1 {
ipAddress
10.20.30.121;
localIdentity {
type
fqdn;
domainName dom;
}
preSharedKey $3$VHkORfcsFY8=;
}
}
To create the IPsec peer peer1:
% set addressContext default ipsec peer peer1
To display the IPsec Policy created above:
% show addressContext default ipsec peer peer1
peer peer1 {
ipAddress
10.24.26.145;
protocol
ikev1;
localIdentity {
type
ipV4Addr;
ipAddress 10.21.25.134;
3–40
IPsec
Address Context
}
preSharedKey
$3$w4J4dBuetKw=;
protectionProfile protprofile1;
}
To display the IPsec SPD:
% show addressContext ipsec spd spd2
TABLE 3–7
IPsec request Parameters
Parameter
Field
Length
Description
ikeSaDelete
N/A
Specifies to delete a specific IKE SA and its IPSEC SAs.
ikeSaDeleteAl N/A
l
Specifies to delete ALL IKE and IPSEC SAs. This is an
ungraceful delete. Ie Peer will not be notified.
ipsecSaDelete N/A
Specifies that only local SPI is required. Ie deletes the
IPsec SA pair incoming Security Parameter Index value
(LOCAL SPI).
3–41
Address Context
Link Detection Group
This Link Detection Group object allows you to group link interfaces (LIFs) and
associated Link Monitors together and track link verification failures within the
group. A Link Detection Group will be configured with a unique name and a
failover threshold. The Link Detection Group tracks the number of link verification
failures that have occurred among the Link Monitors configured.
If a process ends on a active node, a forcible switchover/failover occurs
irrespective of the health status of the standby node (unhealthy/healthy). A pingpong situation can occur in this case as there would be automatic switchover
when LDG is down on the standby node.
In addition to a Failover Threshold, a Link Detection Group can also be configured
with values for the verifyTimer, responseTimer, reattemptTimer and
retries. These values will be used for each Link Monitor belonging to the group,
unless that Link Monitor is configured with its own unique values for these fields.
NOTE
Link detection failure alarms are generated by Link Verification
Manager (LVM) and are raised only when LVM is configured. NRS
generated alarms must be raised even if the LVM is configured or not.
NOTE
If no LDG is configured on the management ports, then SBC 5x00
allows manual switchover.
Command Syntax
% set addressContext <addressContext> linkDetectionGroup
<linkdetectionGroup>
ceName <ceName>
linkMonitor <linkMonitor>
reattemptTimer <reattemptTimer>
responseTimer <responseTimer>
retries <retries>
state <state>
threshold <threshold>
type <type>
verifyTimer <verifyTimer>
3–42
Address Context
% show addressContext <addressContext> linkDetectionGroup
<linkDetectiongroup>
ceName <ceName>
linkMonitor <linkMonitor>
retries <retries>
state <state>
type <type>
% delete addressContext <addressContext> linkDetectionGroup
<linkDetectionGroup>
Command Parameters
TABLE 3–8
LINK DETECTION GROUP Parameters
Parameter
Field
Length
Description
addressConte 1-23
xt
context is a container of objects that correspond to a specific
IP Addressing domain. Must be 1-23 characters.
linkDetectio N/A
ngroup
Specifies the table of user configured link detection group.
ceName
1-23
Specifies the name of the compute element (CE) that hosts
this link detection group.
NOTE
ceName is not the system name.
For an HA system, link detection
needs to be setup on both CEs.
linkMonitor
N/A
Specifies a link monitor that monitors a link to a destination
for a specific interface.
reattemptTim 300er
10000
Specifies the time to wait for a link verification reattempt.
Must be 300-10000, default is 1000 (milliseconds).
responseTime 500r
10000
Specifies the time to wait for a link verification attempt. Must
be 500-10000, default is 1000 (milliseconds).
3–43
Address Context
TABLE 3–8
LINK DETECTION GROUP Parameters (Continued)
Parameter
Field
Length
retries
1-10
Specifies the number of retries before link verification is
considered failed. Must be 1-10, default is 3.
state
N/A
Specifies the administrative state of the Link Detection
Group.
Description
• enabled - turned on and active
• disabled (default) - not in use
threshold
0-10
Specifies the link detection group threshold. Default is 2.
A value of 0 used to disable the fault reporting and the
switchover is attempted.
Use the set addressContext addressContextname
linkDetectionGroup linkdetectiongroupname
cename ceName state disabled command to disable link
detection.
When a nonzero threshold value is specified for a standby
module, then in order for that module to be activated by a
switchover, the number of link failures present must be less
than that value. When threshold or more link failures are
present, the switchover is not attempted.
N/A
type
Specifies the interface type supported by this link detection
group.
• ip (default)
• mgmt - indicates types of interfaces that are monitored with this
Link Detection Group.
verifyTimer
100060000
Specifies the time interval between link verification attempts.
Default is 15000.
It is the frequency at which an ICMP echo request is sent.
displaylevel 1-64
commands.
Command Example
To display the configuration of all link detection parameters:
// Management link detection group
% show addressContext default linkDetectionGroup a1_mgmt_ldg
3–44
ceName
sbx48.eng.sonusnet.com;
type
mgmt;
threshold
1;
verifyTimer
1000;
responseTimer
500;
Address Context
reattemptTimer 300;
retries
2;
state
enabled;
linkMonitor mgmt1_lm {
interfaceGroup
mgmtGroup;
interface
mgmtIntf1;
destination
10.9.16.162;
verifyTimer
1000;
responseTimer
500;
reattemptTimer
300;
state
enabled;
}
linkMonitor mgmt2_lm {
interfaceGroup
mgmtGroup;
interface
mgmtIntf2;
destination
10.9.16.238;
verifyTimer
1000;
responseTimer
500;
reattemptTimer
300;
state
enabled;
}
// IP link detection group
% show addressContext default linkDetectionGroup pkt0_ldg48
ceName
type
ip;
threshold
1;
verifyTimer
1000;
responseTimer
500;
reattemptTimer 300;
retries
2;
state
enabled;
linkMonitor pkt0_lm {
interfaceGroup
IFG-INT;
interface
lif_eth1;
destination
10.9.48.87;
verifyTimer
1000;
responseTimer
500;
reattemptTimer
300;
3–45
Address Context
state
enabled;
}
linkMonitor pkt0_lm2 {
interfaceGroup
IFG-INT;
interface
lif_eth1;
destination
10.128.45.35;
verifyTimer
1000;
responseTimer
500;
reattemptTimer
300;
state
enabled;
}
The show command will only show values that you have changed, and show
details command will show all attributes. For example, to display the complete
details of all link detection parameters:
% show details addressContext a1 linkDetectionGroup
linkDetectionGroup LDG-A1 {
ceName
type
ip;
threshold
1;
verifyTimer
15000;
responseTimer
1000;
reattemptTimer 300;
retries
2;
state
enabled;
linkMonitor LM-A1 {
interfaceGroup
IFG-INT;
interface
lif_eth1;
destination
10.9.48.87;
verifyTimer
15000;
responseTimer
1000;
reattemptTimer
1000;
state
enabled;
}
linkMonitor LM1-A1 {
3–46
interfaceGroup
IFG-INT;
interface
lif_eth1;
destination
10.9.48.165;
verifyTimer
15000;
responseTimer
1000;
Address Context
reattemptTimer
1000;
state
enabled;
}
}
To display the link detection group statistics:
% show table addressContext default
linkDetectionGroupStatistics
NAME
SINGLE
DOUBLE
FAILURES
FAILURES
FAILURES
------------------------------------------pkt0_ldg39
0
0
0
pkt0_ldg48
0
0
0
a1_mgmt_ldg
0
0
0
a2_mgmt_ldg
0
0
0
To display the link detection group status:
show table addressContext default linkDetectionGroupStatus
NAME
FAILURES
----------------------pkt0_ldg39
0
pkt0_ldg48
0
a1_mgmt_ldg
0
a2_mgmt_ldg
0
[ok][2011-06-14 11:26:27
Link Monitor
The link monitor object allows you to monitor a link for a specific interface and
belongs to a link detection group.
A new Link Monitor is created for each link interface (LIF) that is configured for link
verification. The Link Monitor is provided with a destination to use for link
verification as well as the Link Detection Group to which it belongs. The Link
Monitor is responsible for pinging that destination, processing responses and
determining when the interface should be considered failed. It reports such
failures to its Link Detection Group. For more information on link detection group,
refer to "Link Detection Group" on page 3–42 .
You must configure link monitors for the active and standby SBC 5x00 with
different destinations, to avoid a failure scenario where the active and standby
SBC 5x00 fail back and forth due to link detection failures caused by loss of
communication with a single destination.
3–47
Address Context
The active and standby SBC 5x00 should be connected to different physical
hardware (that is, switches) to avoid a single point of failure.
Each Link Monitor that is configured can also be configured with unique values for
the Verify Timer, Response Timer, Reattempt Timer, and Maximum
Retries. If configured, these values override the values configured for the Link
Detection Group.
Each Link Monitor will set a timer while waiting to perform its next verification. The
timeout for this timer is based on the configured Verify Timer value. When a
ping is in progress and the Link Monitor is awaiting the response from the
destination, a timer is set based on the configured Response Timer value.
When the response times out and the Link Monitor retries, the Reattempt
Timer value is used while waiting for the response.
When the number of consecutive failures reaches the Maximum Retries value,
the Link Monitor considers the link verification as failed and reports this to its Link
Detection Group.
While in the failed state, the Link Monitor will continue to attempt to ping the
destination so that the failed condition can eventually clear. This is done at the
rate specified by the Verify Timer.
The Link Monitor also supports a NULL destination (0.0.0.0), which disables the
link verification for that LIF. The LIF will still be considered failed if there is a
hardware failure.
Command Syntax
// Manadatory parameters required to configure a Link Monitor.
<linkdetectionGroup> linkMonitor <linkMonitor>
destination <destination>
state <state>
NOTE
Note that interfaceGroup and interface are key references that are
used to specify the interface that is to be monitored. The Link Monitor
will not begin link verification until the interfaceGroup and
interface are configured, the destination is configured and the state
of both the Link Monitor and its Link Detection Group are enabled.
// Non-manadatory parameters that can be used to configure a Link Monitor.
interface <interface>
interfaceGroup <interfaceGroup>
3–48
Address Context
retries <retries>
% show addressContext <addressContext> linkDetectionGroup
destination <destination>
interface <interface>
interfaceGroup <interfaceGroup>
retries <retries>
state <state>
% delete addressContext <addressContext> linkDetectionGroup
Command Parameters
TABLE 3–9
LINK Monitor Parameters
Field
Length
Parameter
Description
Mandatory parameter descriptions for Link Monitor.
addressConte 1-23
xt
context is a container of objects that correspond to a specific
IP Addressing domain. Must be 1-23 characters.
destination
N/A
Specifies the destination IPv4 or IPv6 address for link
verification.
state
N/A
Specifies the administrative state for link verification for the
IP interface.
Non-mandatory parameter descriptions for Link Monitor.
linkDetecti
onGroup
N/A
Specifies the name of the link detection group to which this
link monitor belongs. For more information, refer to "Link
Detection Group" on page 3–42.
linkMonitor
1-23
Specifies a link monitor that monitors a link to a destination
for a specific interface.
3–49
Address Context
TABLE 3–9
LINK Monitor Parameters (Continued)
Parameter
Field
Length
interface
N/A
Description
Specifies the name of the IP or management interface to be
monitored.
NOTE
IP or MGMT interface can be
configured, depending on the type
that is configured for the
LinkDetectionGroup.
interfaceGr
oup
N/A
Specifies the name of the IP interface group to be
monitored.
reattemptTi
mer
N/A
Specifies the time to wait for a link verification reattempt.
responseTim
er
N/A
retries
N/A
Minimum timer value is 300 (milliseconds). The reattempt
timer has no default for LinkMonitor. The default for
LinkDetectionGroup is 1000 (milliseconds).
Specifies the time to wait for a link verification attempt.
Minimum timer value is 300 (milliseconds). The response
timer has no default value for LinkMonitor. The default
value for LinkDetectionGroup is 1000 (milliseconds).
Specifies the number of retries before link verification is
considered failed.
Minimum is 1. This field has no default for LinkMonitor.
The default for LinkDetectionGroup is 3.
verifyTimer
N/A
Specifies the time interval between link verification attempts.
Range is 1000-60000 (milliseconds). The verify timer has no
default value for LinkMonitor. The default timer value for
LinkDetectionGroup is 15000 (milliseconds).
displaylevel 1-64
commands.
Command Example
To display the configuration of all link detection parameters:
% show details addressContext defaultAddressContext
linkDetectionGroup Alpha linkMonitor Alpha-1
3–50
addressContext
defaultAddressContext;
interfaceGroup
IFG_AS;
interface
LIF_ETH2;
destination
10.160.48.230;
Address Context
verifyTimer
5000;
responseTimer
1500;
reattemptTimer
800;
retries
4;
state
disabled;
To configure VLAN tagged IP interfaces:
set addressContext default ipInterfaceGroup VLAN50
ipInterface pkt0.50 ceName fiji01 portName pkt0 ipAddress
10.151.50.128 prefix 24 vlanTag 50 altIpAddress
2050:FEED:DEAD:BEEF:10:151:50:128 altPrefix 64
commit
ipInterface pkt0.50 state enable mode inservice
3–51
Address Context
commit
To configure link detection for the management ports:
NOTE
By default the management port state is ‘UP’ therefore, when
management LDG is not configured, there is no automatic switchover.
NOTE
ipInterfaceGroup and ipInterface should not be configured for
mgmt0 and mgmt1 ports. You can configure mgmt0 and mgmt1 ports with
mgmtIpInterfaceGroup and mgmtIpInterface.
// Configure link detection for CE1 & CE2
set addressContext default linkDetectionGroup a1_mgmt_ldg
ceName andros01 type mgmt
threshold 2 retries 2
verifyTimer 1000 responseTimer 500 reattemptTimer 300
linkMonitor mgmt1_lm destination 10.151.41.15
3–52
Address Context
linkMonitor mgmt1_lm interfaceGroup mgmtGroup interface
mgmtIntf1
linkMonitor mgmt1_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
mgmtIntf2
reattemptTimer 300
ceName andros02 type mgmt
mgmtIntf3
reattemptTimer 300
3–53
Address Context
mgmtIntf4
reattemptTimer 300
commit
linkMonitor mgmt1_lm state enabled
commit
state enabled
state enabled
commit
To configure link detection for the packet ports:
// Configure link detection on the 50-net
set addressContext default linkDetectionGroup a1_50pkt_ldg
ceName andros01 type ip
3–54
Address Context
linkMonitor pkt0.50_lm destination 10.151.50.38
linkMonitor pkt0.50_lm interfaceGroup VLAN50 interface
pkt0.50
linkMonitor pkt0.50_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
pkt1.50
reattemptTimer 300
pkt0.50
reattemptTimer 300
3–55
Address Context
pkt1.50
reattemptTimer 300
commit
linkMonitor pkt0.50_lm state enabled
commit
state enabled
state enabled
commit
NOTE
Default state of management ports is set to 'up' instead of ‘down’.
Hence, there is no automatic switchover if management LDG is
configured either on active or standby.
To configure link detection on the 51-net
3–56
Address Context
pkt0.51
reattemptTimer 300
pkt1.51
reattemptTimer 300
3–57
Address Context
pkt0.51
reattemptTimer 300
pkt1.51
reattemptTimer 300
commit
commit
state enabled
state enabled
commit
3–58
Address Context
To configure link detection on the 52-net:
pkt2.52
reattemptTimer 300
pkt3.52
reattemptTimer 300
3–59
Address Context
pkt2.52
reattemptTimer 300
pkt3.52
reattemptTimer 300
commit
commit
state enabled
state enabled
3–60
Address Context
commit
To display the link monitor statistics:
% show table addressContext default linkDetectionGroup
a1_mgmt_ldg linkMonitorStatistics
MIN
MAX
AVERAGE
SINGLE
NAME
TIME TIME TIME
REPLIES
DOUBLE
DUPLICATE
LATE
FAILURES FAILURES FAILURES REPLIES REPLIES
----------------------------------------------------------------------------------------mgmt1_lm
0
586
9303
1286
0
0
0
578
0
mgmt2_lm
0
478
8135
1225
0
0
0
578
0
To display the link monitor status:
% show table addressContext default linkDetectionGroup
a1_mgmt_ldg linkMonitorStatus
NAME
MONITOR
LINK
STATUS
STATUS
-----------------------------mgmt1_lm
monitoring
up
mgmt2_lm
monitoring
up
3–61
Address Context
Static Route
Static Route
The staticRoute object is used to configure:
•
•
"Static IP Routes for IP interfaces" on page 3–62
"Static Route for Management Interfaces" on page 3–64
Static IP Routes for IP interfaces
The staticRoute object is used to configure static IP routes for the IP
interfaces. A static route indicates the nextHop gateway and IP interface that is
used for a particular peer network IP prefix.
A route preference may be configured for static routes as shown in the
command syntax. The lower the preference value, the more likely the route is
to be used.
Command Syntax
set addressContext <addressContext> staticRoute
<destinationIpAddress>
<prefix> <nextHopIPaddress> <ipInterfaceGroupName>
<ipInterfaceName> preference <preferenceNumber>
% show addressContext <addressContext> staticRoute
<destinationIpAddress>
preference <preferenceNumber>
% delete addressContext <addressContext> staticRoute
<IpAddress>
3–62
Static Route
Address Context
Command Parameters
TABLE 3–10 Static Route Parameters
Parameter
Field
Length
Description
addressContex 1-23
t
destinationIp N/A
Address
Specifies the destination IP address. The following IP
address types are supported:
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880). Default is 0:0:0:0:0:0:0:0.
prefix
N/A
Specifies the IP prefix of this static route entry.
nextHopIPaddr N/A
ess
Specifies the IPv4 or IPv6 address of the next system en
route to the destination.
ipInterfaceGr N/A
oupName
Specifies the name of the IP interface group.
ipInterfaceNa N/A
me
Specifies the name of the IP interface for this entry.
preferenceNum N/A
ber
Specifies the route preference value. The management
route preference range is 1-99 and the packet route
preference range is greater than or equal to 100.
displaylevel
1-64
commands.
Command Example
To display static routes:
% show addressContext default staticRoute
staticRoute 10.6.30.105 32 10.34.26.1 LIF2 lif_eth3 {
preference 10;
}
preference 10;
}
preference 10;
}
3–63
Address Context
Static Route
preference 1;
}
preference 10;
Static Route for Management Interfaces
The staticRoute object is used to configure static IP routes for the
management interfaces. A static route indicates the nextHop gateway and
management interface that is used for a particular peer network IP prefix.
For details on Static IP Routes for Management interfaces, refer to "Management
Static Route" on page 7–42.
3–64
Zone
Address Context
Zone
A zone is used to group a set of objects unique in a particular customer
environment. A zone can contain one SIP signaling port and one H.323 signaling
port. A zone can contain multiple SIP and H.323 trunk groups.
Command Syntax
// Mandatory parameters to configure a zone:
% set addressContext <addressContext> zone <zone>
id <id>
% set addressContext <addressContext> zone <zone>
cac <cac>
dnsGroup <dnsGroup>
gwSigPort <gwSigPort>
gwTrunkGroup <gwTrunkGroup>
h323SigPort <h323SigPort>
h323TrunkGroup <h323TrunkGroup>
ipPeer <ipPeer>
remoteDeviceType <remoteDeviceType>
sipSigPort <sipSigPort>
sipTrunkGroup <sipTrunkGroup>
% show addressContext <addressContext> zone <zone>
cac <cac>
bandwidthLimit
callLimit
displaylevel
egress
emergencyOversubscription
ingress
registrationLimit
dnsGroup <dnsGroup>
// Mandatory parameters to configure a Gateway Signaling port:
3–65
Address Context
Zone
ipAddress
ipInterfaceGroupName
portNumber
// Non-mandatory parameters that can be used to configure a Gateway Signaling
port:
mode
role
state
// Mandatory parameters to configure a Gateway trunkgroup:
accMc1Percent
accMc2Percent
accTimer
action
dryUpTimeout
ingressIpPrefix
// Non-mandatory parameters that can be used to configure a Gateway
trunkgroup:
cac
callReservation
media
mode
// Mandatory parameters to configure a H323 Signaling port:
action
dscpValue
h225IpAddress
mode
portNumber
state
// Non-mandatory parameters that can be used to configure a H323 Signaling port:
3–66
Zone
Address Context
dryUpTimeout
h245IpAddress
// Mandatory parameters to configure a H323 trunkgroup:
action
dryUpTimeout
ingressIpPrefix
mode
sendingCompleteEnbloc
state
id <id>
// Non-mandatory parameters that can be used to configure a H323 trunkgroup:
cac
callReservation
callRouting
media
packetOutage
policy
services
ipPeer <ipPeer>
defaultForIp
ipAddress
ipPort
policy
sip
// Mandatory parameters to configure a SIP Signaling port:
dscpValue
ipAddressV4
ipAddressV6
mode
3–67
Address Context
Zone
portNumber
state
tcpConnectTimeout
tlsProfileName
transportProtocolsAllowed
// Non-mandatory parameters that can be used to configure a SIP Signaling port:
dscpValue
ipAddressV4
ipAddressV6
mode
portNumber
state
tcpConnectTimeout
tlsProfileName
transportProtocolsAllowed
// Mandatory parameters to configure a SIP trunkgroup:
action
dryUpTimeout
ingressIpPrefix
mode
state
// Non-mandatory parameters that can be used to configure a SIP trunkgroup:
cac
callReservation
callRouting
congestionHandling
media
packetOutage
policy
services
signaling
3–68
Zone
Address Context
% delete addressContext <addressContext> zone <zone>
% request addressContext <addressContext> zone <zone>
sipSigConnResetAll <sipSigConnResetAll>
sipSigPortResetAll <sipSigPortResetAll>
Command Parameters
TABLE 3–11 Zone Parameters
Parameter
Field
Length
addressContex 1-23
t
zone
1-23
Description
Specifies the name of the zone. Must be 1-23 characters.
You can configure signaling, media, and control for a zone
in the address context.
NOTE
Zone name is unique across all
address contexts.
3–69
Address Context
Zone
TABLE 3–11 Zone Parameters (Continued)
Parameter
Field
Length
cac
N/A
Description
Specifies Call Admission Control (CAC) parameters for all
peers using this zone. Following are CAC parameters:
• bandwidthLimit - Specifies the total bandwidth limit in units
of 1Kbps on this zone. Valid values are 0-2147483647 or
unlimited.
For one g711u/a call leg, SBC 5x00 allocates 124 Kbps
bandwidth, so if bandwidthLimit is 1240, then 10 g711u/a
call legs can be up.
• callLimit - Specifies the total number of calls allowed on
this zone. Valid values are 0-2147483647 or unlimited.
• egress - Specifies the egress-specific call admission control
configuration. The egress call maximum limit parameters are
as follows:
- callBurstMax - Specifies the maximum allowed burst
(above the allowed sustained rate) for egress call attempts.
Valid values are 1-200 or unlimited.
NOTE
You can set both callRateMax
and callBurstMax as
unlimited but not either of
them. For example, if you set
callRateMax to 10, then
callBurstMax has to be
assigned with valid value.
- callRateMax - Specifies the maximum sustained egress
call rate allowed in calls/second. Valid values are 1-100 or
unlimited.
- registerBurstMax - Specifies the maximum allowed
burst (above the allowed sustained rate) for egress initial SIP
registrations. Valid values are 1-200 or unlimited.
- registerRateMax - Specifies the maximum sustained
egress rate of initial SIP registrations allowed on this zone.
Valid values are 1-100 or unlimited.
NOTE
You can set both
registerBurstMax and
registerRateMax as
unlimited but not either of
them. For example, if you set
registerBurstMax to 10, then
callBurstMax has to be
assigned with valid value.
3–70
Zone
Address Context
Parameter
cac
(continued)
Field
Length
N/A
Description
• emergencyOversubscription - Specifies the
oversubscription of resources (as a percentage) that is
allowed for emergency calls. Valid values are 0-1000 or
unlimited. Default value is 10 percent.
• ingress - Specifies the ingress-specific call admission
control configuration. The ingress call maximum limit
parameters are as follows:
- callBurstMax - Specifies the maximum allowed burst
(above the allowed sustained rate) for ingress calls. Valid
values are 1-200 or unlimited.
- callRateMax - Specifies the maximum sustained ingress
call rate allowed in calls/second. Valid values are 1-100 or
unlimited.
- packetRateMax - Specifies the maximum sustained packet
rate allowed (in packets/second). Valid values are 1-65535 or
unlimited.
- registerBurstMax - Specifies the maximum burst (above
the allowed sustained rate) for initial SIP registrations. Valid
values are 1-200 or unlimited.
- registerRateMax - Specifies the maximum sustained rate
of initial SIP registrations allowed in registrations/second.
Enter valid values between 1-100 or unlimited.
• registrationLimit - Specifies the number of registrations
allowed on this zone. Valid values are 0-2147483647 or
unlimited.
dnsGroup
N/A
Specifies the default DNS Server Group for this zone.
Formore information on DNS group, refer to "DNS Group"
on page 3–3.
3–71
Address Context
Zone
Parameter
Field
Length
gwSigPort
N/A
Description
Specifies the Gateway (GW) signaling ports for this zone.
Enter a value between 1 and 2048. Following are the
Gateway (GW) signaling port parameters:
• ipAddress - Specifies the IP Address of the Gateway Signal
Listen Port. This is V4 IP address in dotted decimal form (for
example 128.127.50.224).
• ipInterfaceGroupName - Specifies the IP interface group
to be used by this gateway signaling port.
• mode - Specifies the operational mode for this gateway
signaling port. Mode can be inService or outOfService.
• portNumber - Specifies the TCP Port number of the gateway
signaling port (default is 2569).
• role - Specifies the role of the gateway signal listen port.
Select any one of the option:
- primary (default) - Creates a listen port for Gateway
signaling traffic.
- secondary - Specifies the an alternate port used for
listening only and cannot be used to establish new gateway
signal links.
• state - Specifies the administrative state of gateway listen
port. Select any one of the option:
- disabled - Specifies that the gateway listen port is
not active.
- enabled - Specifies that the gateway listen port is
active.
3–72
Zone
Address Context
Parameter
Field
Length
gwTrunkGroup
N/A
Description
Specifies the gateway trunk groups for this zone. Following
are the Gateway (GW) trunk group parameters:
• accMc1Percent - Specifies the percentage of calls to
continue to send to a remote congested gateway (in MC1).
Enter value in range of 0-100 percent. Default is 90 percent.
• accMc2Percent - Specifies the percentage of calls to
continue to send to a remote congested gateway (in MC2).
Enter value in range of 0-100 percent. Default is 70 percent.
• accTimer - Specifies the automatic congestion control timer.
Enter value in range of 0-10 seconds. Default is 0 seconds.
• action -Specifies the action when putting this gateway trunk
group outOfService. This object controls whether calls are
forced off or allowed to dryup upon a mode out-of-service.
dryup - If dryupTimeout is not specified or it's value is 0,
then no new calls are accepted and all currently active calls
are allowed an indefinite time period to finish. If
dryupTimeout is nonzero, then no new calls are accepted,
and all currently active calls are allowed dryupTimeout
minutes to finish. After dryupTimeout minutes, all
remaining active calls are dropped.
force - Specifies that no new calls are accepted and all
active calls are immediately dropped.
undefined - Specifies that all calls are dropped and the
Gateway trunk group is immediately set to outOfService.
• cac - Specifies the call admission control parameters for this
gateway trunk group. Specify the following CAC parameters:
- bandwidthLimit - Specifies the total media bandwidth
limit (in K bits/sec). Enter unlimited or value in range of 02147483647.
- callLimit - Specifies the total number of concurrent calls
(either ingress or egress) allowed. Enter unlimited or value
in range of 0-2147483647.
- egress - Specifies the egress-specific call admission
control configuration. Specify the following egress
parameters:
callBurstMax - Specifies the maximum allowed burst
(above the allowed sustained rate) for egress call
attempts. Enter unlimited or value in range of (1-200)
calls/second.
callRateMax - Specifies the maximum allowed burst
calls/second.
3–73
Address Context
Zone
Parameter
gwTrunkGroup
(continued)
Field
Length
N/A
Description
- emergencyOversubscription - Specifies the
allowed for emergency calls. Enter value in range of (0-1000)
percent. Default is 10.
- ingress - Specifies the ingress-specific call admission
control configuration. Specify the following ingress
parameters:
(above the allowed sustained rate) for ingress calls.
Enter unlimited or value in range of (1-200) calls/
second.
callRateMax - Specifies the maximum sustained
ingress call rate allowed in calls/second. Enter
unlimited or value in range of (1-100) calls/second.
• callReservation - Specifies the parameters for reserving
a portion of the resources for specific call direction or type for
this gateway trunk group. Specify the following call
reservation parameters:
- inbound - Specifies the percentage of callLimit reserved
for handling inbound calls. This is the percentage of channels
reserved for handling inbound calls. Default is 0%.
Percentage selection allowed in 5% increments. Enter value
in 5% increments in range of (0-100) percent.
- incomingCallMinimum - Specifies the minimum number
of incoming call allowed when reservations are enabled for
this gateway trunk group. Enter value in range of 0-128.
Default is 1.
- outgoingCallMinimum - Specifies the minimum percent
of outgoing call allowed when reservations are enabled for
this gateway trunk group. Enter value in range of 0-100.
Default is 10.
- priorityCallMinimum - Specifies the minimum number
of priority calls allowed when reservations are enabled for this
gateway trunk group. Enter value in range of 0-100. Default is
1.
- silc - Specifies the SILC traffic control configuration.
Specify the following SILC parameters:
MC1Percent - Specifies the percentage of calls to
accept when the machine congestion level is 1. Enter
value in range of 0-100 percent. Default is 75.
3–74
Zone
Address Context
Parameter
gwTrunkGroup
(continued)
Field
Length
Description
N/A
state - Specifies the administrative state to enable/
disable the SILC traffic control. Select any one of the
option:
- disabled - Specifies that the SILC control is not in
effect for incoming calls.
- enabled - Specifies that the SILC control is in effect
for incoming calls.
- state - Specifies the administrative state to disable or
enable the call reservation feature on a gateway trunk group.
• dryUpTimeout - Specifies the dryup timeout (in minutes)
when this gateway trunk group is outOfService with dryup
action. Enter a value in the range of 1-1440. Default is 5
minutes.
• ingressIpPrefix - Specifies the ingress peers matching
these ingress IP prefixes will be assigned to this gateway
trunk group. Enter IPv4 or IPv6 address in the following
format:
IPv4 - Specifies the V4 IP address in dotted decimal form
(for example 128.127.50.224).
IPv6 - Specifies the V6 IP address in hexadecimal/colon
form (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880). Default is 0:0:0:0:0:0:0:0.
prefixLength - Specifies the number of bits of
address which form the network part of the IP
address. Rest of the bits (128 – prefix length) specify
the host part of the IP address. Must be 0-128.
• media - Specifies the parameters associated with media
features for this gateway trunk group. Specify the following
media parameters:
- mediaIpInterfaceGroupName - Specifies the interface
group to be used for media.
- sourceAddressFiltering - If enabled, filter out
incoming media packets which do not match the expected
source IP address and UDP port. Options are:
enabled
disabled
• mode - Specifies the operational mode of this gateway trunk
group. Mode can be inService or outOfService.
3–75
Address Context
Zone
Parameter
gwTrunkGroup
(continued)
Field
Length
N/A
Description
• packetOutage - Specifies the packet outage detection
parameters for this gateway trunk group.
- bandwidthLimitReduction - Specifies the amount to
reduce the bandwidth limit (as a percentage of the configured
limit) when a packet outage is detected. Enter value in range
of 0-100 percent. Default is 50 percent.
- detectionInterval - Specifies the size of the packet
outage detection interval in minutes. Enter value in range of 51440 minutes. Default is 15 minutes.
- detectionState - Used to enable automatic bandwidth
reduction when a packet outage is detected. Select any one of
the option:
enabled - Specifies that the automatic bandwidth
reduction will occur when a packet outage is detected.
disabled - Specifies that the packet outages are not
detected and the maximum bandwidth limit is restored.
- minimumCalls - Specifies the number of calls with
outages required within the current interval to declare a
packet outage event. Enter value in range of 0-65535. Default
is 1000.
- minimumDuration - Specifies the minimum outage (in
milliseconds) on a call for that call to be counted as part of the
packet outage detection algorithm. Enter value in range of 065535 in milliseconds. Default is 6000 milliseconds.
• state - Specifies the administrative state to disable or enable
a gateway trunk group. Select any one of the option:
enabled - Enables the administrative state of the trunk
group
disabled - Disables the administrative state of the trunk
group.
3–76
Zone
Address Context
Parameter
Field
Length
h323SigPort
N/A
Description
Specifies the H323 Signaling Port for this zone. Following
are H323 signalling port parameters:
• action - Specifies the object that controls whether calls are
dryup - If dryupTimeout is not specified or it's value is
0, then no new calls are accepted and all currently
active calls are allowed an indefinite time period to
finish. If dryupTimeout is nonzero, then no new calls
are accepted, and all currently active calls are allowed
dryupTimeout minutes to finish. After dryupTimeout
minutes, all remaining active calls are dropped.
force - Specifies that no new calls are accepted and all
active calls are immediately dropped.
• dryUpTimeout - Specifies the dryup timeout (in minutes)
when this H323 Signaling Port is outOfService with dryup
action. Enter a value in the range of 0-1440. Default is 0.
• dscpValue - Specifies the DSCP value (0-63) for packets
from this H323 Signaling Port. Default is 0.
• h225IpAddress - Specifies the H225 IPv4 address of the
H323 Signaling Port.
• h245IpAddress - Specifies the H245 IPv4 address of the
H323 Signaling Port.
to be used by this Signaling Port.
• mode - Specifies the operational mode for this H323 Signaling
Port. Mode can be inService or outOfService.
• portNumber - Specifies the TCP Port number of the H323
Signaling Port (default is 1720). Enter a value in the range of
1 - 65535.
• state - Specifies the administrative state of the H323
Signaling Port. Select any one of the option:
signaling port.
enabled - Enables the administrative state of the
signaling port.
3–77
Address Context
Zone
Parameter
Field
Length
h323TrunkGrou N/A
p
Description
Specifies the H323 trunk groups in this zone. Following are
H323 trunk group parameters:
• action - Specifies the action when putting this H323 trunk
group outOfService. This object controls whether calls are
Select any one of the option: dryup, force, undefined.
• cac - Specifies the call admission control parameters for this
H323 trunk group. Specify the following CAC parameters:
limit (in K bits/sec). Enter unlimited or value in range of 02147483647.
(either ingress or egress) allowed. Enter unlimited or value
in range of 0-2147483647.
control configuration. Specify the following egress
parameters:
calls/second.
callRateMax - Specifies the maximum allowed burst
calls/second.
allowed for emergency calls. Enter value in range of (0-1000)
percent. Default is 10.
control configuration. Specify the following ingress
parameters:
(above the allowed sustained rate) for ingress calls.
Enter unlimited or value in range of (1-200) calls/
second.
callRateMax - Specifies the maximum sustained
ingress call rate allowed in calls/second. Enter
unlimited or value in range of (1-100) calls/second.
this H323 trunk group. Specify the following call reservation
parameters:
3–78
Zone
Address Context
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
- inbound - Specifies the percentage of callLimit reserved
for handling inbound calls. This is the percentage of channels
reserved for handling inbound calls. Default is 0%.
Percentage selection allowed in 5% increments. Enter value
in 5% increments in range of (0-100) percent.
of incoming call allowed when reservations are enabled for
this trunk group. Enter value in range of 0-128. Default is 1.
of outgoing call allowed when reservations are enabled for
this trunk group. Enter value in range of 0-100. Default is 10.
of priority call allowed when reservations are enabled for this
trunk group. Enter value in range of 0-100. Default is 1.
Specify the following SILC parameters:
- state - Specifies the administrative state to enable/
disable the SILC traffic control. Select any one of the
option: disabled or enabled.
enable the call reservation feature on a H323 trunk group.
• callRouting - Specifies the parameters and controls used
for routing a call for this H323 trunk group. Specify the
following call routing parameters:
- ansSupervisionTimeout - Specifies the maximum time
(in seconds) from egress call setup to egress receiving an
answer. Enter value in the range 0 - 1000. Default value 300.
- crankBackProfile - Specifies the name of the crank
back profile.
- respectBearerCapability - Control to determine
whether to accept unchanged the Bearer Capability
Information element values received in H.225 SETUP. Select
any one of the option: disabled or enabled.
3–79
Address Context
Zone
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
• dryUpTimeout - Specifies the timeout value in minutes for
the dry up action. Enter value in range of 1-1440 in minutes.
Default is 5 minutes.
these ingress IP prefixes will be assigned to this H323 trunk
group. Enter IPv4 or IPv6 address in the following format:
- IPv4 - Specifies the V4 IP address in dotted decimal form
(for example 128.127.50.224).
- IPv6 - Specifies the V6 IP address in hexadecimal/colon
form (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880). Default is 0:0:0:0:0:0:0:0.
- prefixLength - Specifies the number of bits of address
which form the network part of the IPv6 address. Rest of the
bits (128 – prefix length) specify the host part of the IPv6
address. Must be 0-128.
• media - Specifies the parameters associated with media
features for this H323 trunk group. Specify the following media
parameters:
- directMediaAllowed - If enabled, attempt to set up a
direct-media path so that media flows directly between
endpoints in the same direct-media group. Select any one of
the option: disabled or enabled. Default value is 0. Enter
value in the 0 - 65535.
- directMediaGroupId - Specifies the direct media group
to which this trunk group belongs. Default is 0.
- mediaIpInterfaceGroupName - Specifies the interface
group to be used for media.
- preAllocateResPad - This indicates if a resource pad is
pre-allocated or not during an incoming fast start call
procedure that results in G.711 codec selected for the call.
Options are enabled and disabled.
source IP address and UDP port. Options are enabled and
disabled.
• mode - Specifies the operational mode of this H323 trunk
parameters for this H323 trunk group.
3–80
Zone
Address Context
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
limit) when a packet outage is detected. Enter value in range
of 0-100 percent. Default is 50 percent.
outage detection interval in minutes. Enter value in range of 51440 minutes. Default is 15 minutes.
reduction when a packet outage is detected. Select any one of
the option: disabled or enabled.
packet outage event. Enter value in range of 0-65535. Default
is 1000.
- minimumDuration - Specifies the minimum outage (in
packet outage detection algorithm. Enter value in range of 065535 in milliseconds. Default is 6000 milliseconds.
• policy - Specifies the policy data for this H323 trunk group.
- callRouting - Specifies the parameters and controls
used for routing a call or request to the next-hop entity. Option
is elementRoutingPriority - The Element Routing
Priority table indicates what Call Processing Elements types
(including "none") should be used to determine matching
routing table entries. Routing table lookups are attempted in
priority order for all matching Call Processing Element types
until a match is found. Different Element Routing Priority
profiles can be associated with different (ingress) trunk
groups. If no Element Routing Priority table is explicitly
associated with a trunk group, the DEFAULT_IP Element
Routing Priority profile is used.
- carrier - Specifies the parameters and controls used for
carrier for this trunk group for this H323 trunk group.
- country - Specifies the parameters and controls used for
country for this H323 trunk group.
- digitParameterHandling - Specifies the parameters
and controls used for digit parameter handling for this trunk
group for this H323 trunk group. Options are:
- egressDmPmRule - Specifies the name of the Digit
Manipulation and Parameter Manipulation profile applied
at the egress. Options are:
3–81
Address Context
Zone
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
- PAI_AND_FROM_HEADER
- PAI_DISPLAY_NAMES_1_NTL
- PAI_SIP_DSPNAME_CLG_NAM
- PAI_TEL_DSPNAME_GN_CPN
- PRFX_TO_HEADER_CDPN_NTL
- PRFX_TO_HEADER_GDPN_NTL
- PRFX_TO_HEADER_OCN_NTL
- SIP_ADD_PLUS
- SIP_REMOVE_CLG81
- SIP_REMOVE_PLUS1
- SIP_REMOVE_PLUS39
- SIP_REMOVE_PLUS44
- SIP_REMOVE_PLUS49
- SIP_REMOVE_PLUS52
- SIP_REMOVE_PLUS81
- SIP_REMOVE_PLUS86
- SIP_REMOVE_PLUS91
- ingressDmPmRule - Specifies the name of Digit
Manipulation and Parameter Manipulation profile applied at
the ingress.
- SIP_ADD_PLUS
- SIP_REMOVE_CLG81
- SIP_REMOVE_PLUS1
- SIP_REMOVE_PLUS39
- SIP_REMOVE_PLUS44
- SIP_REMOVE_PLUS49
- SIP_REMOVE_PLUS52
- SIP_REMOVE_PLUS81
- SIP_REMOVE_PLUS86
- SIP_REMOVE_PLUS91
- numberingPlan - Specifies the name of the Numbering
Plan profile. Options are:
- CHINA_NUM_PLAN
- GENERIC_NUM_PLAN
- GERMANY_NUM_PLAN
- INDIA_NUM_PLAN
- ITALY_NUM_PLAN
- JAPAN_NUM_PLAN
- MEXICO_NUM_PLAN
- NANP_ACCESS
- UK_NUM_PLAN
3–82
Zone
Address Context
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
- localizationVariant - Specifies the parameters and
controls used for localization variant for this H323 trunk
group. Options are:
- generic
- japan
- northAmerica
- media - Specifies the parameters associated with media
policy for this H323 trunk group. Option is:
- packetServiceProfile - Specify the name of the
Packet service profile. Options are: DEFAULT
G711_PSP, G729_PSP, SIPART_PSP,
SIPART_PSP_S35
- services - Specifies the parameters associated with
various enhanced services and features for this H323 trunk
group. The sub entity is classOfService.
- signaling - Specifies the parameters controlling the
specifics of the SIP signaling for this H323 trunk group. Option
is:
- ipSignalingProfile - Specify the name of the IP
Signaling profile. Options are: DEFAULT_H323,
DEFAULT_SIP, SIPART_IPSP
• sendingCompleteEnbloc - This indicates whether to send
complete IE in enbloc SETUP message or not. Options are
enabled and disabled.
• services - Specifies the parameters associated with
advanced services and features for this H323 trunk group.
- longDurationCall - Specifies the parameters
associated with long duration call supervision. Specify the
following long duration call parameters:
ldcAction - Specifies the action to take if the long
duration call timer expires. Select any one of the option:
noAction, release, trap, trapAndRelease.
ldcEmergencyCalls - Specifies the whether
Emergency Calls should be excluded from or included in
Long Duration Call Disconnect procedures. Select any
one of the option: exclude or include.
ldcRelCause - Specifies the Q.850 release value to
use should the call be released due to long duration call
timer expiry. Default is 41.
3–83
Address Context
Zone
Parameter
Field
Length
h323TrunkGrou N/A
p (continued)
Description
ldcTimeout - Specifies the timeout value of the long
duration call timer in minutes. Allowed values are 0 to
disable the timer, 60-2880 minutes to set the timer.
Default is 0.
- overlapDialing - Specifies the Overlap dialing
parameters.
minDigitsForQuery - This parameter controls the
number of called address digits to be collected before
performing the 1st policy query during overlap receiving.
If this is 0, then this parameter is irrelevant in controlling
policy query.
overlapState - Control to determine if Overlap
Dialing is supported. Select any one of the option:
disabled egressOnly enabled
ingressOnly.
a H323 trunk group. Select any one of the option:
signaling port.
enabled - Enables the administrative state of the
signaling port.
id
N/A
Specifies a unique numerical ID for this zone. Enter value
in range of 1-2048. Default is 3.
NOTE
Zone ID is unique across all
address contexts.
3–84
Zone
Address Context
Parameter
Field
Length
ipPeer
N/A
Description
This table contains information about each static IP Peer in
this zone. Following are ip peer parameters:
• defaultForIp - Set to true if this peer should be used for
the ipAddress and ephemeral port on ingress. Set to false if
this peer will not be used for the ipAddress and ephemeral
port on ingress.
• ipAddress - Specifies the IPv4 or IPv6 address of the Peer.
• ipPort - The TCP/UDP port for this peer. Must be -1-32767.
Default value is 9000.
• policy - Specifies the policy parameters and profiles
associated with this IP peer.
- description - Specify the IP peer policy description.
- ipSignalingProfile - Specify the IP signaling profile
name. Options are: DEFAULT_H323 DEFAULT_SIP
SIPART_IPSP
- packetServiceProfile - Specify the packet service
profile name. Options are: DEFAULT G711_PSP
G729_PSP SIPART_PSP SIPART_PSP_S35
- sip - Specify SIP fqdn or fqdnPort.
- fqdn - Specify the FQDN used to send egress calls
or requests to this peer.
- fqdnPort - Specify the FQDN port. Must be -132767. Default value is 0.
• sip - Specify the SIP parameters for the IP peer. Specify the
SIP CAC profile name. The sub-entity option is:
cacProfile. For details about CAC profile, refer to "SIP
CAC Profile" on page 6–189.
3–85
Address Context
Zone
Parameter
Field
Length
sipSigPort
N/A
Description
Specifies the Sip Signaling Port for this zone. Enter a value
between 1 and 2048. Following are ip signalling port
parameters:
• dscpValue - Specifies the DSCP value between 0-63 for
packets from this SIP Signaling Port. Default value is 0.
• ipAddressV4 - Specifies the IPv4 address for this SIP
signaling port.
(for example 128.127.50.224).
• ipAddressV6 - Specifies the IPv6 address for this SIP
signaling port.
IPv6 - This is V6 IP address in hexadecimal/colon form (for
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880). Default is 0:0:0:0:0:0:0:0.
used by this SIP Signaling Port.
• mode - Specifies the operational mode for this SIP Signaling
Port. Mode can be inService or outOfService.
• portNumber - Specifies the UDP/TCP port number of SIP
Signaling Port (default is 5060).
• state - Specifies the administrative state of the SIP Signaling
Port. Select any one of the option:
signaling port.
enabled -Enables the administrative state of the
signaling port.
• tcpConnectTimeout - This object indicates the maximum
time, in seconds, allowed for SBC 5x00 to establish an
outbound TCP connection. Enter a value in the range of 0180. Default is 5.
• tlsProfileName - Specifies the name of the TLS Profile
used by this Signaling Port.
• transportProtocolsAllowed - Specifies the transport
protocols allowed on this signaling port. The transport
protocols allowed are: sip-tcp, sip-tls-tcp, sip-udp.
3–86
Zone
Address Context
Parameter
Field
Length
sipTrunkGroup N/A
Description
Specifies the SIP trunk groups for this zone. Following are
SIP trunk group parameters:
• action - Specifies the action when putting this SIP trunk
group outOfService. The options are dryUp or force. This
action controls whether calls are forced off or allowed to dryup
upon a mode out-of-service.
• cac - Specifies the call (and registration) admission control
parameters for this SIP trunk group. Options are:
limit (in K bits/sec). Must be "unlimited" or value in range of
0-2147483647.
(either ingress or egress) allowed. Must be "unlimited" or
value in range of 0-2147483647.
control configuration. Options are:
- callBurstMax - Specifies the maximum allowed
burst (above the allowed sustained rate) for egress call
attempts. Enter "unlimited" or value in range of 1200 calls per second.
- callRateMax - Specifies the maximum sustained
egress call rate allowed in calls per second. Enter
"unlimited" or value in range of 1-100 calls per
second.
- registerBurstMax - Specifies the maximum
allowed burst (above the allowed sustained rate) for
egress initial SIP registrations. Enter "unlimited" or
value in range of 1-200 registrations.
- registerRateMax - Specifies the maximum
sustained egress rate of initial SIP registrations
allowed. Enter "unlimited" or value in range of 1100 registrations.
allowed for emergency calls. Must be 0-1000 percent. Default
value is 10 percent.
- estimatedChildRegistrations - Specifies the
estimated number of child registrations (i.e., the estimated
number of P-Associated-URIs in 200 OK). Must be 1-256
registrations. Default is 1 registration.
control configuration. Options are:
3–87
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
- callBurstMax - Specifies the maximum allowed
burst (above the allowed sustained rate) for ingress
calls. The maximum sustained call rate allowed in calls
per second. Must be "unlimited" or enter value in
range of 1-200 calls per second.
- callRateMax - Specifies the maximum sustained
ingress call rate allowed in calls/second. The
maximum sustained call rate allowed in calls/second.
Must be "unlimited" or enter value in range of 1-100
calls per second.
- registerBurstMax - Specifies the maximum
allowed burst (above the allowed sustained rate) for
initial SIP registrations. The maximum allowed burst of
SIP registration attempts. Must be "unlimited" or
enter value in range of 1-200 registrations.
- registerRateMax - Specifies the maximum
sustained rate of initial SIP registrations allowed in
registrations per second. Must be "unlimited" or
enter value in range of 1-100 registrations.
- registeredEndpointCacProfile - Specifies the
endpoint CAC profile containing CAC parameters that are
applied individually to each registrant.
- registrationLimit - Specifies the total number of
concurrent SIP registrations allowed. Enter "unlimited" or
value in range of 0-2147483647.
this SIP trunk group. The options are:
- inbound - Specifies the percentage of callLimit reserved for
handling inbound calls. Default is 0 percent. Enter value in 5
percent increments in the range of 0-100 percent.
of incoming call allowed when reservations are enabled. Enter
value in range of 0-128. Default is 1.
of outgoing call allowed when reservations are enabled. Enter
value in range of 0-100. Default is 10 percent.
of priority call allowed when reservations are enabled. Enter
value in value in range of 0-100. Default is 1.
3–88
Zone
Address Context
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
state - Specifies the administrative state to enable/
disable the SILC traffic control.
enable the call reservation feature on a SIP trunk group.
• callRouting - Specifies the parameters and controls used
for routing a call or request to the next-hop entity for this SIP
trunk group.
- ansSupervisionTimeout - This is the maximum time (in
seconds) from egress call setup to egress receiving an
answer. Default value is 300.
- ansSupervisionTimeoutAction - Specifies the action to
take if the answer supervision timer expires. Options are:
release trapAndRestart
- crankBackProfile - Specifies the name of the crank back
profile.
- internationalNoaPlus - If enabled, set the CPN and
CIN NOA to International when number begins with '+'.
Options are: disabled enabled
- useRouteSet - This controls the usage of route sets in
routing a call. The possible options are: disabled
received stored storedAll
• congestionHandling - Specifies the parameters governing
the SBC 5x00 behavior when under local overload or when
receiving congestion indications from downstream peers.
- egressThrottling - Determines whether received peer
overload indications (SIP 503 w/ Retry After) cause to
adoptively throttle egress calls and registrations to that peer.
Options are:
- disabled (default) - Specifies the traffic rate
allowed to this peer is unchanged when a 503
response is received from the peer.
- enabled - Specifies the traffic rate allowed to
this peer is decreased when a 503 response is
received from the peer.
3–89
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
- retryAfterMax - Specifies the maximum Retry-After time
(in seconds) when an ingress call or register is rejected with
503 due to local overload. Default value is 30.
- retryAfterMin - Specifies the minimum Retry-After time
(in seconds) when an ingress call or register is rejected with
503 due to local overload. Default value is 10.
• dryUpTimeout - Specifies the timeout value in minutes for
the dry up action. Enter the value between 1-1440 minutes.
Default is 5.
these ingress IP and prefix will be assigned to this SIP trunk
group. Enter IPv4 or IPv6 address in the following format:
(for example 10.11.12.0 24).
IPv6 - Specifies the V6 IP address in hexadecimal/colon
form (for example, fd00:21:445:128::7880 64). Default is
0:0:0:0:0:0:0:0.
prefixLength - Specifies the number of bits of address
which form the network part of the IP address. Rest of the
bits (128 – prefix length) specify the host part of the IP
address. Must be 0-128.
• media -Specifies the parameters associated with media
features for this SIP trunk group. Following are the media
parameters:
- comediaConnectionRole - This indicates whether the
SDP offer sent by SBC 5x00 will include any direction
attribute line defined by COMEDIA draft. Select any one of
the option:
active - The SDP offer will include "a=direction: active"
attribute line.
none - The SDP offer will not include a direction
attribute line.
passive - The SDP offer will include "a=direction:
passive" attribute line.
- directMediaAllowed - If enabled, attempt to set up a
direct-media path so that media flows directly between
endpoints in the same direct-media group. Options are:
disabled and enabled.
- directMediaGroupId - This identifies the direct media
group to which this trunk group belongs. Default value is 0.
- lateMediaSupport - Determines whether a SIP late
media (reverse offer) INVITE should be converted to a
forward offer on egress. Select any one of the option:
convert, passthru.
3–90
Zone
Address Context
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
- maxPtimeDefault - This field indicates the default packet
size. The default value is 150 millisecond.
- mediaAddrType - Specifies the Media Address Type
attribute determines the type of IP address used in the offer.
The possible values are iPv4, iPv6 and
matchSigAddrType.
- mediaIpInterfaceGroupName - Specifies the name of
the IP interface group for media.
source IP address and UDP port. Specify enabled or
disabled option for the source address filtering.
- tmr64K - Specifies the transmission Medium Requirement
Unrestricted 64kbit/s control is needed for SIP-ISUP
interworking. Specify enabled or disabled option for this
TMR control.
• mode - Specifies the operational mode for this SIP trunk
parameters for this SIP trunk group.
limit) when a packet outage is detected. Must be 0-100
percent. Default is 50 percent.
outage detection interval in minutes. Must be 5-1440 minutes.
Default is 15 minutes.
reduction when a packet outage is detected.
packet outage event. Must be 0-65535. Default is 1000.
- minimumDuration - This is the minimum outage (in
packet outage detection algorithm. Must be 0-65535 in
milliseconds. Default is 6000 milliseconds.
• policy - Specifies the policy data for this SIP trunk group.
- callRouting - Specifies the parameters and controls
used for routing a call or request to the next-hop entity.
- carrier - Specifies the parameters and controls used for
carrier for this trunk group.
3–91
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
- country - Specifies the parameters and controls used for
country for this trunk group.
- digitParameterHandling - Specifies the parameters
and controls used for digit parameter handling for this trunk
group for this trunk group. Options are:
- egressDmPmRule - Specifies the name of Digit
Manipulation and Parameter Manipulation profile applied
at the egress. Options are:
- SIP_ADD_PLUS
- SIP_REMOVE_CLG81
- SIP_REMOVE_PLUS1
- SIP_REMOVE_PLUS39
- SIP_REMOVE_PLUS44
- SIP_REMOVE_PLUS49
- SIP_REMOVE_PLUS52
- SIP_REMOVE_PLUS81
- SIP_REMOVE_PLUS86
- SIP_REMOVE_PLUS91
- ingressDmPmRule - Specifies the name of Digit
Manipulation and Parameter Manipulation profile applied at
the ingress. Options are:
- SIP_ADD_PLUS
- SIP_REMOVE_CLG81
- SIP_REMOVE_PLUS1
- SIP_REMOVE_PLUS39
- SIP_REMOVE_PLUS44
- SIP_REMOVE_PLUS49
- SIP_REMOVE_PLUS52
- SIP_REMOVE_PLUS81
- SIP_REMOVE_PLUS86
- SIP_REMOVE_PLUS91
3–92
Zone
Address Context
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
- numberingPlan - Specifies the name of the Numbering
Plan profile.
- CHINA_NUM_PLAN
- GENERIC_NUM_PLAN
- GERMANY_NUM_PLAN
- INDIA_NUM_PLAN
- ITALY_NUM_PLAN
- JAPAN_NUM_PLAN
- MEXICO_NUM_PLAN
- NANP_ACCESS
- UK_NUM_PLAN
- localizationVariant - Specifies the parameters and
controls used for localization variant for this trunk group.
Options are: generic japan northAmerica
- media - Specifies the parameters associated with media
policy for this SIP trunk group. Option is: DEFAULT
- services - Specifies the parameters associated with
various enhanced services and features for this SIP trunk
group.
- signaling - Specifies the parameters controlling the
specifics of the SIP signaling for this SIP trunk group. Options
are: DEFAULT_H323 DEFAULT_SIP SIPART_IPSP
- sipDomain - Specifies the parameters controlling the
specifics of the SIP domain for this SIP trunk group.
• services - Specifies the parameters associated with various
enhanced services and features for this SIP trunk group.
- dnsSupportType - Specifies whether to use the DNS
server for just A-record lookups, or for full NAPTR/SRV/A
lookup as specified in RFC3263. Options are: a-only, asrv-naptr.
- emergencyCallProfile - Specifies the name of the
emergency call profile.
- longDurationCall - Specifies the parameters associated
with long duration call supervision.
action - This is the action to take if the long duration
call timer expires. Options are noAction, release,
trap, trapAndRelease.
emergencyCalls - Specifies whether Emergency Calls
should be excluded from or included in Long Duration
Call Disconnect procedures. Options are exclude,
include.
relCause - Specifies the Q.850 release value to use
should the call be released due to long duration call timer
expiry. Default value is 41.
3–93
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
timeoutValue - Specifies the timeout value (in
minutes) of the long duration call timer. Default value is
0.
- natTraversal - Specifies the various parameters
associated with network-hosted NAT/NAPT traversal for SIP
endpoints. Specify the following NAT Traversal parameters.
mediaNat - Specifies the whether or not NAT/NAPT
support is required for media. Options are:
- disabled - Support is not required for media.
- enabled - Support is required for media.
- qualifiedPrefix - Specifies the set of IP network prefixes
that an address must match to be considered for NAT
handling. Options are:
- ipAddress - Enter an IPv4 or IPv6 address.
- prefixLength - Specifies the number of bits of
address which form the network part of the IP address.
Rest of the bits (128 – prefix length) specify the host
part of the IP address. Must be 0-128.
- signalingNat - This indicates whether or not NAT/NAPT
support is required for signaling. Options are:
disabled - NAT/NAPT support is not required for
signaling.
enabled - NAT/NAPT support is required for
signaling.
- tcpKeepaliveTimer - The NAT keepalive timer (in
seconds) for SIP over TCP. Default value is 240.
- udpKeepaliveTimer - The NAT keepalive timer (in
seconds) for SIP over UDP. Default value is 60.
- overlapAddressing - Parameters associated with
overlap addressing support.
minDigitsForQuery - Specifies the minimum number
of digits that need to be received before attempting to
route the call. Default value is 0.
- overlapState - Specifies the whether to support or not
support overlap addressing. Options are:
disabled - When disabled, does not support
overlap addressing.
enabled - When enabled, supports overlap addressing.
timer2 - Specifies the maximum time (in seconds)
between sending an INVITE and receiving a backward
message. Default value is 0.
3–94
Zone
Address Context
Parameter
Field
Length
Description
sipTrunkGroup N/A
(continued)
timer3 - Specifies the maximum time (in seconds)
between receiving a 484 Address Incomplete message
(if there are no outstanding INVITE transactions) and the
receipt of fresh address information. Default value is 4.
- preconditions - Indicates level of preconditions support.
Options are none, required, supported.
- sipArsProfile - Specifies the name of the SIP ARS
(Address Reachability Service) profile.
• signaling - Specifies the parameters controlling the
specifics of the SIP signaling.
- P-HeaderExtensions - Prescribes behavior associated
with various 3GPP P-Headers. Specify the following
parameters.
addEgressOrigCa - If enabled, allow P-Orig-CA
header to be sent on the egress. Select any one of the
useIngressOrigCa - If enabled, honor P-Orig-CA
header received on the ingress. Select any one of the
- allowByeChallenge - This flag enables the ByeChallenge feature. When this flag is enabled, the BYE's might
get challenged either by 401 or 407 and the call is released
only when the BYE with appropriate credentials are received.
Options for this flag: enabled or disabled. The default
option: disabled.
- backwardInfoMsgConDialog - If enabled, an INFO
message will only be sent after confirmed Dialog. Select any
one of the option: disabled or enabled.
- callingParty - Specifies what SIP headers may be used
when determining the Calling Party information.
cpcParamFromHeader - SIP Mapping CPC parameter
from incoming call to outgoing call. Options are
default, fromheader, paitel.
fromHdrForCallingParty - If enabled, the FROM
header will be used to form the Calling-Party-ID provided
no allowed PAI/PPI/RPI header is present. Select any
one of the option: disabled or enabled.
paiForCallingParty - If enabled, the PAI header (if
present) will be accepted to form the Calling-Party-ID.
Select any one of the option: disabled or enabled.
ppiForCallingParty - If enabled, the PPI header (if
rpiForCallingParty - If enabled, the RPI header (if
3–95
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
trustedSourceForIsup - Used to indicate if the
message came from a trusted source and the FROM
header can be used to map into ISUP parameters.
- causeCodeMapping - Controls the mapping of CPC cause
codes to/from SIP cause codes. Specify the following
parameters.
cpcSipCauseMappingProfile - Specifies the name
of the CPC to SIP cause mapping profile. Select any one
of the option: defaultCpcSip,
defaultQ1912CpcSip, defaultRFC3398CpcSip,
defaultTs29163CpcSip.
sipCpcCauseMappingProfile - Specifies the name
of the SIP to CPC cause mapping profile. Select any one
of the option: defaultQ1912SipCpc,
defaultRFC3398SipCpc, defaultSipCpc,
defaultTs29163SipCpc
- DefaultCallingPartyNumber - Specifies the
defaultCallingNumber for Caller Privacy feature. If the party
number is configured and the flag,
mslyncprivacysupport, is enabled, The configured
number will be inserted as the user name of either the from
header or the P-Asserted-Identity fields depending on
the configuration.
- factorValue - Specifies the factor value used to interwork
the SIP Max-Forwards header and the ISUP Hop counter
parameter.
- interOperatorID - Specifies the Inter Operator ID for
MGCF.
- isubParamPreference - This trunk group attribute
specifies how the ISDN Sub-Address parameter shall be
handled in SIP. Select any one of the option: nonstandard,
rfc2806, rfc3966.
- isupMimeBodyRelay - When enabled, an ISUP mime
body received in SIP signaling will be transparently relayed in
egress SIP signaling. When disabled, ISUP mime bodies will
be decoded and interworked based on the egress signaling
configuration. Select any one of the option: disabled or
enabled.
- maxFwdsDefault - Specifies the default value for the Max
Forwards Header. Default value is 70.
- messageManipulation - Manipulation of SIP headers or
content. Specify the following parameters:
includeAppHdrs - Enables an application to add
headers in outgoing messages. Options are:
3–96
- disabled - When enabled, does not allows an
550-05337
— Version 0.3
— Release V03.00.00
application to add headers
in outgoing
messages.
enabledAll-Rights
When
enabled,
allows
anwithout
application
© 2012 Sonus Networks, Inc. Confidential and- Proprietary.
Reserved.
Do not
distribute
permission.
to add headers in outgoing messages.
Zone
Address Context
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
inputAdapterProfile - Specifies the name of the
input adapter profile.
outputAdapterProfile - Specifies the name of the
output adapter profile.
- methods - Specifies whether to allow or reject various SIP
methods.
info - Determines whether INFO method is
included in the Allow header. Select any one of the
option: allow, reject.
message - Determines whether MESSAGE request is
accepted and processed or rejected with 405. Select any
one of the option: allow, reject.
notify - Determines whether NOTIFY request is
options - Determines whether OPTIONS request is
publish - Determines whether PUBLISH request is
refer - Determines whether REFER request is
register - Determines whether REGISTER method is
included in the Allow header. Select any one of the
option: allow, reject.
subscribe - Determines whether SUBSCRIBE request
is accepted and processed or rejected with 405. Select
any one of the option: allow, reject.
update - Determines whether UPDATE request is
one of the following option: allow reject.
- privacyParamRestricted - SIP Mapping Privacy
Header parameters from incoming call to outgoing call. Select
any one of the option: default, idonly.
- psxRouteForSubscribe - This flag specifies whether to
use PSX routes for routing the SUBSCRIBE to registered
users. This flag can be enabled or disabled.
- registration - Specifies the parameters controlling
registration relay behavior.
3–97
Address Context
Zone
Parameter
Field
Length
sipTrunkGroup N/A
(continued)
Description
expires - This is the time (in seconds) a SIP endpoint's
registration session lasts before requiring re-registration.
Specify time in seconds. Default is 3600 seconds.
insideExpiresMinimum - This controls the initial
expires value in a REGISTER relayed to a registrar.
Specify time in seconds. Default is 3600 seconds.
requireRegistration - This flag should be SUPPORTED
when the associated trunk group is used for endpoints
optionally requiring registration. Select any one of the option:
none, required, required-nonpriority, supported,
supported-group.
- rel100Support - This controls the 100rel support for the
reliability of provisional messages as specified in RFC3262.
- relayNonInviteRequest - Relay Non Invite Requests.
- retryCounters - Retry counter values for various SIP
request types. Specify the following parameters.
bye - Maximum number of retransmissions for SIP BYE
request. Default value is 3.
cancel - Specifies the maximum number of
retransmissions for SIP CANCEL request. Default value
is 3.
general - Specifies the maximum number of
retransmissions for generic SIP request. Default value is
7.
invite - Specifies the maximum number of
retransmissions for SIP INVITE request. Default value is
6.
reInvite - Specifies the maximum number of
retransmissions for SIP Re-INVITE request. Default
value is 3.
- routeMsgValidation - Specifies if route validation
should be done for the received message and if the message
should be validated to ensure it is SIP-only or SIP-I. Select
any one of the option: noValidation, sipI, sipOnly.
- strictParse - Enables strict SIP Parsing. Select any one
of the option: disabled or enabled.
- timers - Retransmission and session-keepalive timer
parameters. Specify the following parameters.
3–98
Zone
Address Context
Parameter
Field
Length
Description
sipTrunkGroup N/A
(continued)
sessionKeepalive - This is the SIP protocol session
keep-alive timer (in seconds). Default value is 1800.
sessionMinSE - Specifies the minimum session
expires. Default value is 90.
sessionTerminationDeltaTime - Specifies the time
before session expiration (in seconds) at which the SBC
5x00 should send a BYE if no session refresh request
has been received. Default value is 0.
t1 - This is the SIP protocol retransmission timer T1 (in
milliseconds). Default value is 500.
t2 - This is the SIP protocol timer T2 (in milliseconds).
tcpRetransmitTimer - Specifies the retransmit timer
(in seconds) for SIP request over TCP. Default value is 6.
- transportPreference - Specifies the preference
ordering of allowed SIP transports. Specify the following
parameters:
preference1 - This first choice of transport protocol for
SIP calls. Select any of the following options: none
tcp tls-tcp udp
preference2 - This second choice of transport
protocol for SIP calls. Select any of the following options:
none tcp tls-tcp udp
preference3 - This third choice of transport protocol
for SIP calls. Select any of the following options: none
tcp tls-tcp udp
preference4 - This fourth choice of transport protocol
for SIP calls. Select any of the following options: none
tcp tls-tcp udp
- uriPreference - This indicates URI presentation
preference for outgoing messages. Select any one of the
option: none, sip, tel.
- validateAor - This flag specifies if the AoR needs to be
validated or allows anonymous users to call.
- variantType - Specifies the variant of functionality. Select
any one of the option: mgcf, mgcf, q1912, sonus, ttc, uk.
a SIP trunk group.
displaylevel
1-64
sipSigConnRes N/A
etAll
commands.
Set operation on this object resets all the statistics
counts to zero.
3–99
Address Context
Zone
Parameter
Field
Length
Description
sipSigPortRes N/A
etAll
Set operation on this object resets all the statistics
counts to zero.
Command Example
To display the configured Zone and ID assignments:
% show addressContext default zone EXTERNAL
zone EXTERNAL {
id 2;
ipPeer HUMPI_ext_peer {
ipAddress 10.34.9.70;
ipPort
9065;
state
enabled;
policy {
description
"";
sip {
fqdn "";
}
packetServiceProfileId "";
ipSignalingProfileId
"";
}
}
sipSigPort 2 {
LIF2;
ipAddress
10.34.9.104;
portNumber
5060;
state
enabled;
transportProtocolsAllowed sip-udp,sip-tcp,sip-tlstcp;
}
sipTrunkGroup HUMPI_EXT {
state enabled;
mode
inService;
policy {
carrier
3–100
0000;
Zone
Address Context
country
1;
sipDomain
"";
localizationVariant northAmerica;
digitParameterHandling {
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
elementRoutingPriority DEFAULT_IP;
}
media {
packetServiceProfile DEFAULT;
}
services {
classOfService DEFAULT_IP;
}
signaling {
ipSignalingProfile DEFAULT_SIP;
}
}
signaling {
methods {
subscribe allow;
}
}
media {
mediaIpInterfaceGroupName LIF2;
}
ingressIpPrefix 10.34.9.70 32;
}
}
% show addressContext default zone INTERNAL
zone INTERNAL {
id 1;
ipPeer HUMPI_int_peer {
ipPort
7056;
3–101
Address Context
Zone
state
enabled;
policy {
description
"";
sip {
fqdn "";
}
packetServiceProfileId "";
ipSignalingProfileId
"";
}
}
sipSigPort 1 {
LIF1;
ipAddress
10.34.9.103;
portNumber
5060;
state
enabled;
transportProtocolsAllowed sip-udp,sip-tcp,sip-tlstcp;
}
sipTrunkGroup HUMPI_INT {
state enabled;
mode
inService;
policy {
carrier
0000;
country
1;
sipDomain
"";
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
}
media {
}
services {
3–102
Zone
Address Context
}
signaling {
ipSignalingProfile DEFAULT_SIP;
}
}
signaling {
methods {
notify allow;
}
}
media {
mediaIpInterfaceGroupName LIF1;
}
ingressIpPrefix 10.34.9.70 32;
}
}
To display the configured Zone and ID assignments details with display level set
to 3:
% show addressContext default zone defaultSigZone
displaylevel 3
id 1;
gwSigPort 1 {
ipInterfaceGroupName ipinterface;
ipAddress
1.2.3.4;
portNumber
2569;
role
primary;
mode
inService;
state
disabled;
}
gwTrunkGroup GW1 {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
accMc1Percent 90;
accMc2Percent 70;
accTimer
0;
3–103
Address Context
Zone
}
h323TrunkGroup tg {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
sendingCompleteEnbloc disabled;
}
ipPeer ippeer {
ipAddress
1.2.3.4;
ipPort
0;
defaultForIp false;
}
sipSigPort 1 {
ipinterface;
ipAddressV4
1.2.3.4;
ipAddressV6
2001:DB8:85A3::8A2E:370:7334;
portNumber
5060;
mode
inService;
state
disabled;
tcpConnectTimeout
5;
dscpValue
0;
tlsProfileName
defaultTlsProfile;
transportProtocolsAllowed sip-udp;
}
To display the configured Zone and ID assignments details with display level set
to 5:
% show addressContext default zone defaultSigZone
displaylevel 5
id 1;
gwSigPort 1 {
ipInterfaceGroupName ipinterface;
ipAddress
1.2.3.4;
portNumber
2569;
role
primary;
mode
inService;
state
disabled;
}
3–104
Zone
Address Context
gwTrunkGroup GW1 {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
accMc1Percent 90;
accMc2Percent 70;
accTimer
0;
packetOutage {
minimumDuration
6000;
minimumCalls
1000;
bandwidthLimitReduction 50;
detectionState
disabled;
detectionInterval
15;
}
callReservation {
inbound
1;
state
disabled;
priorityCallMinimum 1;
incomingCallMinimum 1;
outgoingCallMinimum 10;
silc {
state
disabled;
MC1Percent 75;
MC2Percent 25;
}
}
cac {
callLimit
unlimited;
bandwidthLimit
unlimited;
emergencyOversubscription 10;
ingress {
callRateMax
unlimited;
callBurstMax 10;
}
egress {
callRateMax
unlimited;
callBurstMax 10;
3–105
Address Context
Zone
}
}
media {
mediaIpInterfaceGroupName ipinterface;
sourceAddressFiltering
disabled;
}
}
h323TrunkGroup tg {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
sendingCompleteEnbloc disabled;
policy {
carrier
0000;
country
1;
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
}
media {
}
services {
}
signaling {
ipSignalingProfile DEFAULT_H323;
}
}
packetOutage {
3–106
minimumDuration
6000;
minimumCalls
1000;
Zone
Address Context
bandwidthLimitReduction 50;
detectionState
disabled;
detectionInterval
15;
}
callReservation {
inbound
1;
state
disabled;
priorityCallMinimum 1;
incomingCallMinimum 1;
outgoingCallMinimum 10;
silc {
state
disabled;
MC1Percent 75;
MC2Percent 25;
}
}
cac {
callLimit
unlimited;
bandwidthLimit
unlimited;
emergencyOversubscription 10;
ingress {
callRateMax
unlimited;
callBurstMax 10;
}
egress {
callRateMax
unlimited;
callBurstMax 10;
}
}
services {
overlapDialing {
overlapState
disabled;
minDigitsForQuery 0;
}
longDurationCall {
ldcTimeout
0;
ldcAction
noAction;
ldcRelCause
41;
3–107
Address Context
Zone
ldcEmergencyCalls exclude;
}
}
media {
mediaIpInterfaceGroupName ipinterface;
sourceAddressFiltering
disabled;
directMediaAllowed
disabled;
directMediaGroupId
0;
preAllocateResPad
disabled;
}
callRouting {
ansSupervisionTimeout
300;
crankBackProfile
default;
respectBearerCapability disabled;
}
}
ipPeer ippeer {
ipAddress
1.2.3.4;
ipPort
0;
defaultForIp false;
policy {
description
"";
sip {
fqdn
"";
fqdnPort 0;
}
packetServiceProfile "";
ipSignalingProfile
"";
}
}
sipSigPort 1 {
3–108
ipinterface;
ipAddressV4
1.2.3.4;
ipAddressV6
2001:DB8:85A3::8A2E:370:7334;
portNumber
5060;
mode
inService;
state
disabled;
tcpConnectTimeout
5;
Zone
Address Context
dscpValue
0;
tlsProfileName
defaultTlsProfile;
transportProtocolsAllowed sip-udp;
}
To configure Zone CAC:
% set addressContext default zone ZONE1 id 100
commit
To view Zone statistics:
% show table addressContext default zoneCurrentStatistics
To view Zone status:
% show table addressContext default zoneStatus
To configure Trunk Group CAC:
% set addressContext default zone ZONE1 sipTrunkGroup RHEL_1
cac callLimit 200
To view Trunk Group status:
% show table addressContext default zone ZONE1
trunkGroupStatus
To configure SIP Trunk Group CAC:
% set addressContext default zone ZONE1 sipTrunkGroup RHEL_1
cac callLimit 200
To configure registration configurations:
% set addressContext default zone EXTERNAL sipTrunkGroup
EXT_NETWORK signaling registration requireRegistration
required expires 60 insideExpiresMinimum 3600
To create SIP/H323 signaling ports inside zone:
% set addressContext default zone INTERNAL5 id 5 sipSigPort
5 ipAddressV4 10.9.89.10 portNumber 4010
transportProtocolsAllowed sip-udp,sip-tcp,sip-tls-tcp
ipInterfaceGroupName IFG-INT5 state enabled
To show status/statistics of SIP/H323 signaling ports:
% show status addressContext a1 zone INTERNAL
sipSigPortStatus
sipSigPortStatus 1 {
state inService;
}
3–109
Address Context
Zone
% show status addressContext a1 zone INTERNAL
sipSigPortStatistics 1 {
callRate
0;
origCalls 5864747;
termCalls 9410868;
txPdus
55245380;
rxPdus
45825318;
txBytes
26211787697;
rxBytes
18580071475;
inRegs
0;
outRegs
0;
}
Different Signaling Port per AoR Contact
This feature supports the following high-level functionalities:
•
•
•
Using zone level configuration to determine the direction of a request and
hence perform more accurate RCB lookup. Currently SBX relies on the
presence of the “reg-info” parameter to determine the direction of a request.
This approach will not work when interoperating with App Servers that do not
reflect all parameters they received in the Contact header of a REGISTER
request.
Support for 16 signaling ports per zone. Currently the number of signaling
ports per zone is limited to one.
Improved signaling port selection. With multiple signaling ports per zone, the
existing signaling port selection logic shall be enhanced to support the
following:
•
Selecting a different egress SIP signaling port for multiple contacts for the same AoR as
much as possible.
•
All requests from a registered user should be sending out on the egress side through the
same SIP signaling port towards the registrar.
•
A new flag will be introduced to indicate whether a SIP signaling port is facing the IAD
side or the registrar side. This flag will be used to determine the direction of a dialog
initiating/out of dialog requests.
The following CLI commands are used to configure multiple SIP signalings ports
(up to 16) in the same zone facing the AS:
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS id 20
sipSigPort 1 ipAddressV4 10.3.255.1 5060
transportProtocolsAllowed sip-tcp, sip-tls-tcp
ipInterfaceGroupName LIG2 state enabled
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS id 20
sipSigPort 2 ipAddressV4 10.3.255.2 5060
transportProtocolsAllowed sip-udp ipInterfaceGroupName
LIG2 state enabled
3–110
Zone
Address Context
The following CLI commands are used to enable this feature:
% set global signaling sipSigControls multipleContactsPerAoR
enabled
% set addressContext ADDR_CONTEXT_1 zone ZONE_IAD
sipTrunkGroup TG_IAD signaling registration
requireRegistration supported
remoteDeviceType accessDevice
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS
remoteDeviceType appServer
Registering Endpoint Address in X-Header
This feature is intended to provide IP address, port number and the transport
parameters from the src IP packet carried in the REGISTER message reaching
the registrar in the new SIP proprietary header- X-Original-Addr.
The following are the high-level functionalities implemented as part of this feature:
•
•
New flag is added on the trunk group (on SBX) to enable/disable sending the
new proprietary header (X-Original-Addr) to the REGISTRAR. If the flag is set
to “enabled” on the egress trunk group, the header (X-Original-Addr) will go
out in REGISTER message.
Changes made to add new SIP proprietary header X-Original-Addr for both
V4 and V6 IP address.
The following CLI command is used to configure the Endpoint address in XHeader:
sipTrunkGroup TG_AS signaling registration
includeXOriginalAddr enabled
Output
Once the feature is configured there will be additional header (X-Original-Addr) in
the outgoing SIP Register message as follows:
REGISTER sip:10.3.255.150:5060 SIP/2.0
Via: SIP/2.0/UDP
10.3.255.1:5060;branch=z9hG4bK00B000b62fb005af43f
From: <sip:[email protected]>;tag=gK00000fca
To: <sip:[email protected]>
Call-ID: [email protected]
CSeq: 1162827419 REGISTER
Max-Forwards: 70
Allow: INVITE, ACK, CANCEL, BYE, REGISTER, REFER, INFO,
SUBSCRIBE, NOTIFY, PRACK, UPDATE, OPTIONS, MESSAGE,
PUBLISH
Contact: <sip:[email protected]:5060;dtg=TG_INET1;reginfo=200>;q=0.0;expires=3600
3–111
Address Context
Zone
X-Original-Addr:ip=10.4.255.150:port=5060:transport=udp
User-Agent: iPhone-Time to Call-1.1.1-ios-4.3.3
Content-Length: 0
SMM for Mapping Source IP/Port to SDP “c=” Line
This feature is intended to support the following high-level functionalities:
•
•
Uses the existing SMM (SIP Message Manipulation) functionality of the
NBS5200.
Overwrites the IP address in the SDP connection information (“c=”) line with
the source IP address of the received message.
set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
#the criteria
criterion 1 type message
# configure the message criteria
criterion 1 type message message messageTypes all
criterion 1 type message message methodType invite
criterion 2 type messageBody
criterion 2 type messageBody messageBody condition regexmatch regexp numMatch match string "c=IN IP4"
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 2 type messageBody messageBody messageBodyType
all
action 1 type variable
action 1 operation store
action 1 operation store to type variable variableValue
var1
action 1 from type value value "c=IN IP4 "
action 2 type variable operation append
action 2 from type globalVariable globalVariableValue
srcipaddr
action 2 to type variable variableValue var1
3–112
Zone
Address Context
action 3 type messageBody
action 3 operation regsub
action 3 regexp string "c=IN IP4
(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})"
action 3 from type variable variableValue var1
action 3 to type messageBody messageBodyValue all
#enable the state
% set profiles signaling sipAdaptorProfile CHANGEIP1 state
enabled
commit
Output:
set addressContext ADDR_CONTEXT_1 zone ZONE_CUST2
sipTrunkGroup TG_CUST2_1 signaling messageManipulation
inputAdapterProfile CHANGEIP1
Configuring NAT
The SBC 5x00 supports NAT traversal of Signaling and Media. To configure,
perform the following steps:
1. Enable NAT traversal for Signaling:
EXT_NETWORK services natTraversal signalingNat enabled
2. Enable NAT traversal for Media:
EXT_NETWORK services natTraversal mediaNat enabled
3. Configure udpKeepaliveTimer:
EXT_NETWORK services natTraversal udpKeepaliveTimer 60
This value is sent in the 200 OK of the Register to overcome the NAT binding
issue. Configure this value always lesser than the NAT expiry timer.
Configuring DIRECT MEDIA
The SBC 5x00 supports DIRECT MEDIA whenever they are in the same Media
zone and the endpoint negotiate the same codec. To configure, perform the
following steps:
1. Enable media:
EXT_NETWORK media directMediaAllowed enabled
2. Set packet service profile:
3–113
Address Context
Zone
% set profiles media packetServiceProfile DEFAULT flags
useDirectMedia enable
SDP Transperancy
The SDP transparency is intended to support the transparency of ICE parameters
as well as other SDP parameters that are sent transparently through the SBX. The
following are some of the high-level functionality to be implemented as part of this
feature:
•
•
Transparently carry ICE SDP parameters for direct media calls.
Provides a provisioning interface that allows for future extensions of SDP
transparency.
The following set of CLI commands support the use of SDP transparency:
Initially, the direct media is required to be enabled and configured on both the
ingress/egress trunk groups.
% set profiles media packetServiceProfile <DEFAULT_PSP>
flags useDirectMedia enabled
sipTrunkGroup TG_IAD media directMediaAllowed enabled
sipTrunkGroup TG_AS media directMediaAllowed enabled
The following CLI command is used to turn on/off the SDP transparency feature
on both ingress/egress trunk groups:
% set addressContext default zone ZONE1 sipTrunkGroup
SBX10_AS signaling sdpTransparency sdpTransparencyState
enabled
NOTE
Make sure that media PSP DEFAULT is associated to the trunk group.
Deleting a Zone
You delete a zone using the delete addressContext default zone
<zonename> command. You must delete all objects (SIP/H323 signaling ports
and trunk groups) assigned to a zone before deleting a zone.
3–114
Request Commands
Address Context
Request Commands
This section provides all request commands related to Address Context.
CMDS
The cmds command is used to ping other system from SBC 5x00.
Command Syntax
% request addressContext <addressContext> cmds optionsPing
peerIpAddress <peerIpAddress>
peerPort <peerPort>
sigPort <sigPort>
transport <transport>
Command Parameters
TABLE 3–12 CMDS Parameters
Parameter
Field
Length
Description
addressContex 1-23
t
peerIpAddress 1-32
Specifies the Peer SIP Address to ping. Enter IPv4 address
in the following format:
example 128.127.50.224).
peerPort
N/A
Specifies the Peer SIP Port Number to ping.
sigPort
N/A
Specifies the Signaling Port to use for the ping.
transport
N/A
Specifies the Transport Protocol to use. Select any one of
the following transport type:
• tcp
• tls
• udp
3–115
Address Context
Request Commands
DNS Server Reset
The dnsServerReset command is used to reset the DNS server.
Command Syntax
% request addressContext <addressContext> dnsGroup DNS
dnsServerReset
IPSec Request Commands
The IPSec request commands are used to delete IKE SA and IPSec SA.
Command Syntax
% request addressContext <addressContext> ipsec
ikeSaDelete <ikeSaDelete> saIndex <saIndex>
ikeSaDeleteAll <ikeSaDeleteAll>
ipsecSaDelete <ipsecSaDelete> localSPI <localSPI>
TABLE 3–13 IPsec request Parameters
Parameter
Field
Length
ikeSaDelete
N/A
Description
Specifies the name of a specific IKE SA to be deleted by its
IKE handle identifier. Options are:
• saIndex - Enter and unsigned integer.
ikeSaDeleteAl N/A
l
To globally delete every IKE SA
ipsecSaDelete N/A
Delete the IPsec SA pair with a given local tunnel IP
address (LOCAL TUNNEL IP ADDRESS) and a given
incoming Security Parameter Index value (LOCAL SPI).
SIP Request Commands
The following SIP request commands are used to reset the SIP Registration and
SIP subscription.
•
•
3–116
sipRegCountReset - Resets the SIP registration count.
sipRegistrationDeleteById - Delete a SIP registration by ID.
Request Commands
•
•
•
Address Context
sipRegistrationDeleteByIp - Delete a SIP registration by IP address.
sipSubCountReset - Reset the SIP subscription count.
sipSubscriptionDelete - Delete a SIP subscription.
Command Syntax
% request addressContext <addressContext> sipRegCountReset
% request addressContext <addressContext>
sipRegistrationDeleteById id <id>
sipRegistrationDeleteByIp ipAddress <ipAddress>
% request addressContext <addressContext> sipSubCountReset
sipSubscriptionDelete id <id>
Zone Request Commands
The following Zone request commands are used to reset the statistics count and
packet outage.
•
•
•
sipSigConnResetAll - Set operation on this object resets all the statistics
counts to zero on all signaling ports.
sipSigPortResetAll - Set operation on this object resets all the statistics
counts to zero on all signaling ports.
sipTrunkGroup - SIP trunk groups in this zone.
Command Syntax
sipSigConnResetAll
sipSigPortResetAll
sipTrunkGroup <sipTrunkGroup> packetOutage clear
3–117
Address Context
3–118
Request Commands
CHAPTER 4
Global
The global object contains objects that are applicable node wide. Topics include:
•
•
•
•
•
•
•
•
•
•
•
"Call Routing" on page 4–2
"Call Trace" on page 4–15
"Carrier" on page 4–22
"Country" on page 4–24
"NPA/Nxx" on page 4–27
"Script" on page 4–28
"Security" on page 4–30
"Servers" on page 4–32
"Signaling" on page 4–40
"SIP Domain" on page 4–47
"Subscriber" on page 4–48
4–1
Global
Call Routing
Call Routing
Call routing allows call routes and routing labels to be configured. The route has
fields which are matched against call characteristic. It also contains a reference to
a routing label which is selected when a match is successful. The matching
process is partially controlled by Element Routing Priority.
The following diagram shows multiple routes referencing Routing Label.
FIGURE 4–1 Route and Route Label Objects
Configuring Route
SBC 5x00 supports route lookups based on the following:
•
•
•
•
•
•
•
•
•
Destination National
Destination Country
Username
Domain Name
Ingress Trunk group or Carrier or Calling Number
Call Type
Digit Type
Day of Week, Time of Day, Holidays and Special Days
Call Parameters
Command Syntax
To configure a route:
4–2
Call Routing
Global
% set global callRouting route <entityType> <elementID1>
<elementID2> <routingType> <destinationNational>
<destinationCountry> <callType> <digitType>
<timeRangeProfile> <callParameterFilterProfile>
<domainName> routingLabel <routingLabel>
% set global callRouting routingLabel <routingLabelId>
action <action>
overflowNOA <overflowNOA>
overflowNPI <overflowNPI>
overflowNumber <overflowNumber>
routePrioritizationType <routePrioritizationType>
routingLabelRoute <routingLabelRoute>
script <script>
% set global callRouting routingLabel <routingLabel>
routingLabelRoute <routingLabelRoute>
cost <cost>
inService <inService>
ipPeer <ipPeer>
proportion <proportion>
trunkGroup <trunkGroup>
testing <testing>
% show global callRouting route <elementType> <elementID1>
<domainName>
% show global callRouting routingLabel <routingLabel>
routingLabelRoute
routingLabelRoute <sequence>
% show global callRouting displaylevel <displaylevel>
% show global callRouting route
callingNumber <callingNumber>
carrier <carrier>
4–3
Global
Call Routing
none <none>
% delete global callRouting route <elementType> <elementID1>
<domainName>
% delete global callRouting routingLabel <routingLabel>
routingLabelRoute <sequence>
Command Parameters
TABLE 4–1
Call Routing Parameters
Parameter
Field
Length
entityType
N/A
Description
Specifies the entityType which can be any one of the
following:
•
•
•
•
elementId1
0-31
callingNumber
carrier
none
trunkGroup
Specifies the ID1 of the selected entityType. Depending
upon the entityType selection, this field will have different
values.
• For entityType callingNumber, the value is calling
number.
• For entityType carrier, the value is carrier.
• For entityType none, the value is Sonus_NULL.
• For entityType trunkGroup, the value is ingress trunk
group.
4–4
Call Routing
TABLE 4–1
Global
Call Routing Parameters (Continued)
Parameter
Field
Length
elementId2
0-31
Description
Specifies the ID2 of the selected entityType. Depending
upon the entityType selection, this field will have different
values.
• For entityType callingNumber, the value is calling
country.
• For entityType carrier, the value is Sonus_NULL.
• For entityType none, the value is Sonus_NULL.
• For entityType trunkGroup, the value is system name in
upper case.
NOTE
For entity type trunkGroup,
the gateway component name
must be in all UPPER case. For
example:
set global callRouting route trunkGroup
Carrier1 GATEWAY2 standard Sonus_NULL 1
nationalType nationalType ALL none
Sonus_NULL routingLabel To_ABC_Core
routingType
0-32767 Specifies the routing type:
• standard - Use the standard option when the called party
is a number that is for calledNumber or
calledNumber@domain/ipAddress.
• username - Use the username option when the called party
is a username that is for username or username@domain/
ipAddress.
destinationNat
ional
0-63
For standard routingType, the value is the national
number component of the called number. Leading digits
or the complete number can be provisioned.
destinationCou
ntry
0-15
For standard routingType, the value is the called country
code. For username routingType, the value is
Sonus_NULL.
4–5
Global
TABLE 4–1
Call Routing
Parameter
Field
Length
Description
callType
N/A
Specifies the possible values for callType:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
digitType
N/A
Specifies the possible values for digitType:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
4–6
carrierCutThrough
internationalOperator
internationalType
ipVpnService
localOperator
longDistanceOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
private
test
transit
username
all
900PremiumToll
950CarrierAccess
carrierAccess
directoryAssistance
easilyIdentifiableNumber
emergency
governmentEmergency
ieps
internationalType
ipVpn
localOperator
nationalOperator
nationalType
noDigits
otherCarrierChosen
private
serviceAccessCode
subscriberOperator
Call Routing
TABLE 4–1
Global
Parameter
Field
Length
Description
digitType
(continued)
N/A
•
•
•
•
•
•
•
timeRangeProfi
le
0-23
Specifies the timeRange profile assigned to this route.
The timeRange entry specifies the day and time ranges
that apply to this route. Use the default profile ALL or a
custom profile.
callParameterF
ilterProfile
0-23
Specifies the Call Parameter Filter Profile associated with
this route.
subscriberType
test
tollFree
transit
userName
verticalServiceCode
all
Call Parameter Filter Profiles specify call parameters in
addition to the call parameters provisioned on this screen
for the SBC 5x00 to use when selecting a routing label.
domainName
0-63
Specifies the destination domain name. The destination
domain name is a reference to the sipDomain.
routingLabel
N/A
Specifies the Routing Label ID which identifies a set of up
to 200 Routes (199 or fewer Routes if you want to include
an Overflow Number) and/or a Script.
action
N/A
Specifies the type of action to be taken by the routing
label. Options are:
• routes - This routing label returns a set of routes.
• script - This routing label returns a script.
4–7
Global
TABLE 4–1
Call Routing
Parameter
Field
Length
overflowNOA
N/A
Description
Specifies the overflow Nature Of Address (NOA). Options
are:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
4–8
950
aniNotAvailableOrNotProvided
aniOfCalledPartyNationalNumber
aniOfCalledPartyNoNumberPresent
aniOfCalledPartySubscriberNumber
aniOfCallingPartyNationalNumber
aniOfCallingPartySubscriberNumber
any
apnNumberingPlan
ignore
international
internationalNotRestricted
internationalRestricted
national
nationalNotRestricted
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
noNumberOperatorRequested
none
partialCallingLineId
passThrough
sidNumber
spare00
spare0A
spare0B
spare0C
spare0D
spare0E
spare0F
spare01
spare1A
spare1B
spare1C
spare1D
spare1E
spare1F
spare02
spare2A
spare2B
spare2C
spare2D
spare2E
spare2F
spare03
spare3A
spare3B
spare3C
spare3D
spare3F
spare04
spare3E
spare4A
spare4B
spare4C
spare4D
spare4E
spare4F
spare05
spare5A
spare5B
Call Routing
TABLE 4–1
Global
Parameter
Field
Length
Description
overflowNOA
(continued)
N/A
•
•
•
•
•
•
•
•
•
•
•
•
•
overflowNPI
N/A
Specifies the overflow Numbering Plan Indicator (NPI).
Options are:
spare5C
spare5F
spare6B
spare6E
spare7A
spare7D
spare08
spare11
spare14
spare17
spare20
spare23
spare26
•
•
•
•
•
•
spare5D
spare06
spare6C
spare6F
spare7B
spare7E
spare09
spare12
spare15
spare18
spare21
spare24
data
isdn
none
private
spare0Unknown
spare1
spare2
spare6 spare7
• telex
overflowNumber
N/A
spare5E
spare6A
spare6D
spare07
spare7C
spare7F
spare10
spare13
spare16
spare19
spare22
spare25
spare3
spare4
spare5
Specifies the overflow number. If the overflow number is
present, it is used to determine a routing label and
additional routes that will be associated with the call.
Enter a value between 0-31.
4–9
Global
TABLE 4–1
Call Routing
Parameter
routePrioritiz
ationType
Field
Length
N/A
Description
Determines how the PSX allocates the routes contained
within this routing label. Options are:
• allProportionAllocation - The PSX uses proportions
to determine all of the routes in the route list on a call-by-call
basis. For the first route, the PSX follows the process
described above for the Proportion option by generating a
random number. For the second route, the PSX recalculates
the associated random number range for the remaining
routes and then generates a new random number. The PSX
continues this process to populate each of the remaining
routes in the route list.
• leastCostRouting - The PSX determines the routes by
cost, the least (lowest) cost route being the first priority route
selected. Each route can be configured with a cost value in
the Route dialog box. Option is:
- routePrioritizationTypeForEqualCostRoutes In the case of equal cost routes, the Route Prioritization
Type for Equal Cost Routes parameter is used to select a
secondary route prioritization type.
• proportionAllocation - The PSX uses the proportions
to determine the first route on a call-by-call basis. For
example, if the Route Label contains three routes with
assigned proportions of 80, 50, and 30, the system
generates a random number in this case between 0 and
159) and if the number is between 0 and 79, the system sets
the route with the 80 proportion as the first route. If the
random number is between 80 and 129, the system sets the
route with the 50 proportion as the first route. If the random
number is between 130 and 159, the system sets the route
with the 30 proportion as the first route.
• roundRobin - The PSX distributes the call traffic equally
across the routes in a Routing Label. For each call, the
routes are cyclically rotated by one position. For example,
call 1 receives routes 1-10, call 2 receives routes 2-11, call 3
receives routes 3-12, and so on.
• sequence - The PSX allocates the routes in the order of
the values provided in the route Sequence field.
4–10
Call Routing
TABLE 4–1
Global
Parameter
routingLabelRo
ute
Field
Length
N/A
Description
Specifies the data rows for Routing Label. Enter a value
between 0-32000. Options are:
• cost - Enter a value that indicates the relative cost of this
route to the carrier. The cost value is used in least cost
routing calculations; returned routes are ordered based on
cost in ascending order (the least cost route will be the first
one in the returned route list). Values are 1 - 1,000,000; the
default is 1,000,000.
• inService - Specifies that a route is available for routing.
Options are:
- inService - Indicates that this route is available for
routing.
- outOfService - Indicates that this route is not yet
available for routing.
• ipPeer - Indicates an IP peer value in the same zone that
the trunk group belongs to. Enter a string.
• proportion - Indicates a value that specifies the
proportion of calls whether this route should be the first route
choice. Enter a value between 0-999. Default value is 0.
• testing - Specifies the modes for making test calls and
verifying routes before using them. Options are:
- nonTest - When the CPC value in a policy request is Test
Call, the PSX does not return the route. When the CPC
value is not Test Call or is not present in the policy request,
the PSX returns the route. Select this option for routes not to
be returned during testing.
- normal - After testing and verifying a route, select this
option to use the route for live calls. When selected, the PSX
returns the route regardless of the calling party category
(CPC) value, or absence of a CPC value, received in the
policy request. (Default setting).
- test - When the CPC value in a policy request is Test
Call, the PSX returns the route. When the CPC value is not
Test Call or is not present in the policy request, the PSX
does not return the route.
• trunkGroup - Specifies the name of the trunkgroup to use
for this route. Enter a string.
4–11
Global
TABLE 4–1
Call Routing
Parameter
Field
Length
Description
script
N/A
Specifies the different type of scripts. Options are:
• BLOCKING - Script for call blocking.
• DEFAULT_TERMINATING - Default Terminating script with
Release Cause Code set to 16 (Normal Call Clearing).
• NONSUB_DENY - Non-subscriber call not allowed.
• NO_ROUTES_FOUND - No routes found for the call.
• SCREENING - Script for call screening.
• TANDEM - Tandem script.
displaylevel
1-64
commands.
Command Examples
% show global callRouting
route none Sonus_NULL Sonus_NULL standard Sonus_NULL 1
nationalType subscriberType,nationalType ALL none
Sonus_NULL {
routingLabel REHL2_2;
}
route none Sonus_NULL Sonus_NULL standard Sonus_NULL 1
nationalType subscriberType,nationalType ALL none
Sonus_NULL {
routingLabel REHL1_1;
}
NOTE
The value Sonus_Null is displayed when the key in the specified
position is to be wild-carded.
To display call routing label details with display level set to 1:
% show global callRouting displaylevel 1
route trunkGroup TG_SIPART_AS SBX30 standard Sonus_NULL 1
all all ALL none Sonus_NULL;
route trunkGroup TG_SIPART_IAD SBX30 standard Sonus_NULL 1
all all ALL none Sonus_NULL;
routingLabel TO_TG_SIPART_AS;
routingLabel TO_TG_SIPART_IAD;
4–12
Call Routing
Global
To display call routing label details with display level set to 3:
% show global callRouting displaylevel 3
route trunkGroup TG_SIPART_AS SBX30 standard Sonus_NULL 1
all all ALL none Sonus_NULL {
routingLabel TO_TG_SIPART_IAD;
}
route trunkGroup TG_SIPART_IAD SBX30 standard Sonus_NULL 1
all all ALL none Sonus_NULL {
routingLabel TO_TG_SIPART_AS;
}
routingLabel TO_TG_SIPART_AS {
overflowNumber
"";
overflowNOA
none;
overflowNPI
none;
routePrioritizationType sequence;
script
"";
action
routes;
routingLabelRoute 1;
}
routingLabel TO_TG_SIPART_IAD {
overflowNumber
"";
overflowNOA
none;
overflowNPI
none;
script
"";
action
routes;
routingLabelRoute 1;
}
To display call routing label details:
% show global callRouting routingLabel
routingLabel REHL1_1 {
overflowNumber
"";
overflowNOA
none;
overflowNPI
none;
script
"";
action
routes;
routingLabelRoute 1 {
4–13
Global
Call Routing
trunkGroup REHL_1;
ipPeer
REHL_1;
proportion 0;
inService
inService;
testing
normal;
}
}
4–14
Call Trace
Global
Call Trace
This group of commands allows you to create and configure Call Trace Filters that
specify criteria that the SBC 5x00 uses to determine call events added to the
system trace data event log (which uses the “.TRC” file extension). Only the first
three Call Trace filters are logged, unless the stopMatch parameter in enabled.
In this case, the number of filters logged may be less than three.
The stopMatch parameter specifies whether to stop trying to match filter profiles
after a match is found (up to three profiles will be matched). The
maxTriggerCount is used to set/reset the Trigger Count, a mechanism used to
limit the logging of call/error filter events in the .TRC file.
Call Trace Filters
WARNING
Do not turn on the Call Trace Filter to trace all calls. Doing so may
cause poor system performance. Use this mechanism to trace specific
calls.
For Call Trace Filters, you can use the following criteria to designate calls logged
to the trace files:
•
•
•
•
•
•
•
Called Party Number
Calling Party Number
Contractor Number
Peer IP Address
Redirecting Number
Transfer Capability
Trunk Group
Use the match keyword to specify criteria to use to capture call data upon a
match. Use the key keyword to specify criteria on which to filter call data.
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
4–15
Global
•
•
•
•
•
•
•
•
•
•
•
Call Trace
Call terminated
Wait for more digits
Extra digits received
Initiating new attempt
Signal messages received or sent
Egress call setup message
Route lookup failure
Call blocked
SIP signaling events for a single call incoming/outgoing to a particular source/
destination IP endpoint
SIP Protocol Data Units (PDUs) for a single call incoming/outgoing from/to a
particular source/destination IP endpoint
SIP out-of-dialog PDUs such as 18X, BYE, and INFO, regardless of whether
they are successfully parsed
The TRC event log level must be info for this facility to operate properly.
Call Trace Trigger Count
The Trigger Count (maxTriggerCount) is a mechanism used to limit the logging
of call/error filter events in the .TRC file. After configuring and enabling the
callFilter, an ingress/egress call that matches the filter criteria causes the
corresponding events to be logged to the .TRC file, as long as the Trigger Count
has not been reached. Once the configured Trigger Count has been reached, the
matching callFilter will not be triggered and events associated with the call
trace filter will not be logged in the .TRC file. To re-enable triggering, you must
configure the Trigger Count to a nonzero value not greater than 64.
Command Syntax
To configure call trace filters:
// Mandatory parameters that are required to configure a Call filter.
% set global callTrace callFilter <callFilter>
level <level>
match <match>
state <state>
stopMatch <stopMatch>
// Non-mandatory parameters that can be used to configure a Call filter.
key <key>
% set global callTrace errorFilter errorType <errorType>
4–16
Call Trace
Global
% set global callTrace maxTriggerCount <maxTriggerCount>
To enable call tracing based on the called number:
% set global callTrace callFilter <callFilter name> level
<level> state <enabled> key called match called <Called
Number>
To view the recently enabled call trace:
% show table global callTrace callFilter
% show global callTrace
callFilter <callFilter>
errorFilter <errorFilter>
maxTriggerCount <maxTriggerCount>
% show global callTrace callFilter
key <key>
level <level>
match <match>
state <state>
stopMatch <stopMatch>
% show global callTrace displaylevel <displaylevel>
% show global callTrace errorFilter
errorType <errorType>
% show global callTrace maxTriggerCount
% delete global callTrace callFilter <callFilter>
% delete global callTrace errorFilter errorType <errorType>
% delete global callTrace maxTriggerCount <maxTriggerCount>
To enable media packet capture:
mediaPacketCapture enable
To enable call detail capture for a call filter:
callDetailCapture enable
To enable signaling packet capture:
% Set global callTrace signalingPacketCapture enable
4–17
Global
Call Trace
To configure signaling filters:
% set global callTrace signalingFilter <signalingFilter>
addressContext <addresscontext>
peerIpAddressPrefix <peerIpAddressPrefix>
sigPorts <sigPorts>
state <state>
zone <zone>
Command Parameters
TABLE 4–2
Call Trace Parameters
Parameter
Field
Length
Description
callFilter
N/A
Specifies the name of a call trace filter that will be applied
to the system trace data log file. This filter may be
created, configured, and deleted.
level
N/A
Specifies the filter level or minimum severity that warrants
the capture of this call data:
• level1 - Traces everything
• level2 (default) - Trace everything but raw hex dumps
• level3 - Traces only external message information (ISDN/
ISUP/CAS etc.) and errors
4–18
Call Trace
TABLE 4–2
Global
Call Trace Parameters (Continued)
Parameter
Field
Length
match
N/A
Description
Use the match keyword to specify criteria to use to
capture call data upon a match. Options are:
• called - Specifies the called number being traced. Must
be 0-30.
• calling- Specifies the calling number being traced. Must
be 0-30.
• cddn - Specifies the called directory number being traced.
Must be 0-30.
• contractor- Specifies the contractor number being
traced. Must be 0-30.
• peerIpAddress- Specifies the peer IPv4 Address for call
tracing.
• redirecting- Specifies the redirecting number being
traced.
• transferCapability- Specifies the transfer capability of
the call trace filter. Options are:
- audio31Khz - 3.1 kHz Audio - ITC 3.1 kHz audio calls
are traced. The default setting is disabled.
- speech - ITC Speech based calls are traced. The default
setting is disabled.
- unrestricted - Calls with ITC Unrestricted are traced.
The default setting is disabled.
- unrestrictedWithTones - Unrestricted Digital
Information With Tones/Announcements - Calls with ITC
Unrestricted Digital Information With Tones
Announcements are traced. The default setting is
disabled.
- video - Calls with ITC Video are traced. The default
setting is disabled.
• trunkGroup - Specifies the trunk group entry for a Call
Trace Filter.
state
N/A
Specifies the administrative state of this filter:
• disabled (default) - Off. In this state no calls will be traced
by this filter. The filter must be in this state to change its
configuration.
• enabled - On. In this state all calls will be processed by this
filter for possible inclusion in the system trace data log file.
stopMatch
N/A
Specifies whether to stop trying to match filter profiles
after a match is found:
• unsupported (default) - do not stop matching filter profiles
after a match is found (up to three profiles will be matched).
• supported - stop trying to match filter profiles after a match
is found.
4–19
Global
TABLE 4–2
Call Trace
Call Trace Parameters (Continued)
Parameter
Field
Length
Description
N/A
key
Specifies a single call trace filter criterion which is used to
trace a call:
•
•
•
•
•
•
•
called - To trace the called number.
calling - To trace the calling number.
cddn - To trace the called directory number.
contractor - To trace the contractor number.
peerIpAddress - The Peer IP Address used for call trace.
redirecting - To trace the redirecting number
transferCapability - The Transfer Capability of the
call trace filter
• trunkGroup - The Trunk Group entry for a Call Trace Filter.
errorType
N/A
Specifies the type of error to log:
• any - Log all SIP PDUs that meet the requirement of the
parseerror, outofdialog, and early attempt options below.
• earlyattempt - Logs incoming SIP PDUs that result in
early termination of the call (by either the pre-parser or SIP
signaling).
• none (default) - No SIP PDU logging, including validation/
parsing errors.
• outofdialog - Log incoming syntactically correct SIP
PDUs (except INVITE) that do not belong to an existing
dialog.
• parsError - Log received SIP PDUs that fail parsing. If an
error is detected by SIP signaling, the accompanying PDUs
will not be associated with any dialog, including an existing
dialog. Hence all in dialog and out of dialog PDUs are
assigned to this category. If an error is detected at the front
end pre-parser, the PDU is logged by this software and not
forwarded to SIP signaling. This prevents an offending PDU
from being logged by both the pre-parser and SIP signaling.
maxTriggerCoun
t
0-64
Specifies the maximum number of calls that match the
callFilter criteria and the errorFilter type that may
be logged to the .TRC file, per slot. When this limit is
reached on a module in a particular slot, this parameter
value becomes 0 and matching events are no longer
logged. To re-enable logging, you must issue a CLI
command that configures this parameter to a nonzero
value.
Must be 0-64, default is 0.
displaylevel
4–20
1-64
commands.
Call Trace
Global
Command Examples
% show global callTrace callFilter
callFilter callFilter1 {
key called,calling;
}
To display call trace details with display level set to 1:
% show global callTrace displaylevel 1
callFilter AS;
callFilter IAD;
To display call trace details with display level set to 3:
% show global callTrace displaylevel 3
callFilter AS {
state disabled;
level level1;
key
trunkGroup;
}
callFilter IAD {
state disabled;
level level1;
key
trunkGroup;
}
% show global callTrace errorFilter
errorType earlyAttempt;
% show global callTrace maxTriggerCount
maxTriggerCount 2;
4–21
Global
Carrier
Carrier
The global carrier object allows you to configure the carrier. Each Carrier is
assigned a carrier identification code. The SBC 5x00 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 set global carrier command to define a carrier name and
assign it a code.
Command Syntax
% set global carrier <carrierID> services classOfService
DEFAULT_IP
% show global carrier <carrierID>
services
classOfService <classOfService>
% delete global carrier <carrierID>
Command Parameters
TABLE 4–3
Carrier Parameters
Parameter
Field
Length
carrierID
1-4
Description
Specifies a code to be associated with this carrier. May be
up to four numeric digits.
classOfServi N/A
ce
Specifies the default class of service.
displaylevel 1-64
commands.
Command Example
To display the configuration of all carrier parameters:
4–22
Carrier
Global
% show global carrier
carrier 0000 {
services {
classOfService "";
}
}
carrier 333 {
services {
}
}
carrier 444 {
services {
}
}
4–23
Global
Country
Country
The global country object allows you to configure the information about specific
countries in your network. The Country table is pre-populated with sample
Country IDs and descriptions when you install the database. You must populate
the rest of the fields, which are very important to accurate SBC 5x00 call
processing.
Command Syntax
% set global country <countrycode>
listOfNumberOfDigitsToMatch
called <called>
calling <calling>
criteria <crieteria>
% set global country <countrycode> variableLengthDialPlan
<<enable | disable>
% show global country <countrycode>
% show global country listOfNumberOfDigitsToMatch
called <called>
calling <calling>
criteria <crieteria>
% delete global country <countrycode>
4–24
Country
Global
Command Parameters
TABLE 4–4
Country Parameters
Parameter
Field
Length
Description
countrycode
0-15
Specifies a unique identifier for Country Code.
listOfNumber N/A
OfDigitsToMa
tch
variableLen
gthDialPlan
Select any one of the matching pattern.
• called - Comma-separated list of numbers, indicating the
number of digits in the Called Number used for pattern
matching.
• calling - Comma-separated list of numbers, indicating the
number of digits in the Calling Number used for pattern
matching.
• criteria - Applies when numbers are translated using the
SBC 5x00 tables.
N/A
Specifies the variable length Dial Plan flag.
displaylevel 1-64
commands.
Command Example
To display the global configuration of all country codes:
% show global country
1
- A unique identifier for the Country Code.
20
27
30
31
32
33
34
36
39
......................
4–25
Global
Country
NOTE
The show command displays first 100 entries from the country option.
To view the country name that you have created, use wild card.
4–26
NPA/Nxx
Global
NPA/Nxx
The NPA/Nxx object is used to provision the valid national destination code, the
associated country code and LATA, the lookup type for local number portability
(LNP), and a flag indicating whether the national destination code has been
ported for LNP.
Command Syntax
% set global npaNxx <npaNxx> portedFlag <portedFlag>
% show global npaNxx <npaNxx>
% delete global npaNxx <npaNxx>
Command Parameters
TABLE 4–5
NPA/Nxx Parameters
Parameter
Field
Length
Description
npaNxx
N/A
Specifies national destination code.
portedFlag
N/A
Specifies that the national destination code is ported for LNP
when enabled.
displaylevel 1-64
commands.
Command Example
To display the NPA/Nxx configurations:
% show global npaNxx
npaNxx National2 {
portedFlag enable;
}
4–27
Global
Script
Script
The script object is used to view the information about pre-seeded scripts.
Command Syntax
% set global script <script>
description <description>
majorVersion <majorVersion>
minorVersion <minorVersion>
% show global script <script>
majorVersion <majorVersion>
minorVersion <minorVersion>
% delete global script <script>
Command Parameters
TABLE 4–6
Script Parameters
Parameter
Field
Length
script
N/A
Description
Specifies the script file name without the file extension.
Options are:
•
•
•
•
•
•
description
4–28
N/A
BLOCKING
DEFAULT_TERMINATING
NONSUB_DENY
NO_ROUTES_FOUND
SCREENING
TANDEM
Specifies a more descriptive information about the script
Script
TABLE 4–6
Global
Script Parameters (Continued)
Parameter
Field
Length
Description
majorVersio
n
N/A
Specifies the major script version. Enter a value between 0999. Default value is 1.
minorVersio
n
N/A
Specifies the minor script version. Enter a value between 0999. Default value is 0.
displaylevel 1-64
commands.
Command Example
To display the script configuration:
% show global script
script BLOCKING {
description
"";
majorVersion 0;
minorVersion 1;
}
script DEFAULT_TERMINATING {
description
"";
majorVersion 0;
minorVersion 1;
}
script NO_ROUTES_FOUND {
description
"";
majorVersion 2;
minorVersion 1;
4–29
Global
Security
Security
The global security ipsec object allows you to configure system-wide ipsec
parameters, the initial IKE retransmission interval and the IKE retransmission
count.
Command Syntax
% set global security ipsec
ikeRetransmitCount <ikeRetransmitCount>
ikeRetransmitInterval <ikeRetransmitInterval>
% show global security
ipsec
ikeRetransmitCount <ikeRetransmitCount>
% delete global security ipsec ikeRetransmitCount
<ikeRetransmitCount> ikeRetransmitInterval
<ikeRetransmitInterval>
Command Parameters
TABLE 4–7
Parameter
Security Parameters
Field
Length
Description
ikeRetransmi 0-7
tCount
Specifies the Ike Message retransmit count. Default value is
5.
ikeRetransmi 2-10
tInterval
Specifies the Ike Message retransmit interval. Default value
is 4 seconds.
displaylevel 1-64
commands.
Command Example
To display the global configuration of all country codes:
% show global security
4–30
Security
Global
ipsec {
ikeRetransmitInterval 2;
ikeRetransmitCount
2;
}
4–31
Global
Servers
Servers
The global servers object allows you to configure ENUM and E911 servers.
It is also contains global configurations that applies to DNS servers used for SIP
NAPTR, SRV, and A-record lookups.
DNS Server Global Configuration
To create a DNS Server, use the command:
% set global servers dns global
iterationCount <iterationCount>
monitoringInterval <monitoringInterval>
probeInterval <probeInterval>
retransmissionCount <retransmissionCount>
retransmissionTimer <retransmissionTimer>
timeouts <timeouts>
% show global servers dns global displaylevel
% show global servers dns global
timeouts <timeouts>
% delete global servers dns global
4–32
Servers
Global
Command Parameters
TABLE 4–8
Parameter
DNS Server Parameters
Field
Length
Description
iterationCou 0-32
nt
Specifies the global Iteration count limit for DNS iterations of
server requests. Default value is 8.
monitoringIn 0 - 300
terval
Specifies the global monitoring interval (in seconds) for DNS
Servers. Default value is 5.
probeInterva 0 - 300
l
Specifies the global probe interval (in seconds) for
blacklisted DNS Servers. Default value is 5.
retransmissi 0- 20
onCount
Specifies the global retransmission count limit for DNS
iterations of server requests. Default value is 2.
retransmissi 100 onTimer
10000
Specifies the global retransmission timer value (in
milliseconds) for DNS iterations of server requests. Default
value is 500 milliseconds.
timeouts
0 -32
displaylevel 1-64
Specifies the global number of time outs for blacklisting a
DNS Server. Default value is 0.
commands.
Command Example
To display the global configuration of all DNS servers:
% show global servers dns
global {
iterationCount
2;
retransmissionCount 2;
retransmissionTimer 800;
monitoringInterval
60;
timeouts
3;
probeInterval
33;
}
Configuring ENUM Server
To create a ENUM Service, use the command:
// Mandatory parameters required to configure ENUM server.
% set global servers enumService
4–33
Global
Servers
defaultTreatment <defaultTreatment>
// Non-mandatory parameters that can be used to configure ENUM server.
% set global servers enumService
criteria <criteria>
flags <flags>
requestTimeOut <requestTimeout>
serviceType <serviceType>
% set global servers enumDomain
ipAddress1 <ipAddress1>
% show global servers enumService
criteria <criteria>
triggerCriteria <triggerCriteria>
applyFinalTreatment
routeAsDialed
flags <flags>
serviceType <serviceType>
% show global servers enumDomain
% delete global servers enum
4–34
Servers
Global
Command Parameters
TABLE 4–9
ENUM Server Parameters
Parameter
Field
Length
Description
N/A
enum
Specify any one of the following ENUM:
• CNAM
• LNP
defaultTreat N/A
ment
Specifies the default treatment:
• applyFinalTreatment
• routeAsDialed
criteria
N/A
Specifies the trigger criteria.
flags
N/A
Specifies whether to set the flag to enable or disable ENUM
server.
• disable
• enable
requestTimeO 0Specifies request time out. Default value is 2000.
ut
2147483
647
serviceType
N/A
Specify any of the following service type:
• cnam
• lnp
• sipAoR
ipAddress1
N/A
Specifies the IPv4 address for first ENUM server for this
domain.
ipAddress2
N/A
Specifies the IPv4 address for second ENUM server for this
domain.
ipAddress3
N/A
Specifies the IPv4 address for third ENUM server for this
domain.
displaylevel 1-64
commands.
Command Example
To display the global configuration of all ENUM servers:
% show global servers enum
enum CNAM {
4–35
Global
Servers
criteria {
triggerCriteria 44;
}
defaultTreatment routeAsDialed;
flags {
active disable;
}
serviceType
CNAM;
requestTimeOut
0;
}
enum DEFAULT_AIN_SERVICE {
criteria {
triggerCriteria "";
}
Configuring ENUM server for domain e164arpa
ENUM Query is supported in SBC 5x00 for the domain name e164.arpa. The
LWRESD (Light Weight Resolver Daemon) process will take care the ENUM
Query / response with the ENUM Server. The LWRESD command allows you to
configure maximum of 3 ENUM servers.
To configure ENUM server, perform the following steps:
1. Configure Lwresd server:
% set global servers lwresdServer e164.arpa ipAddress1
10.34.26.254
2. For Trunkgroup based ENUM Query , set the profile:
% set profiles digitParameterHandling
numberTranslationCriteria ENUM1 none Sonus_NULL
Sonus_NULL <9845114525> 1 lookupType enumSipAor
% set global servers enum ENUM_S criteria triggerCriteria
ENUM1
% set global servers enum ENUM_S flags active enable
% set global servers enum ENUM_S serviceType sipAor
3. If ENUM entry is not present, to release the call:
% set global servers enum ENUM_S defaultTreatment
applyFinalTreatment
4. When ENUM entry is not present in the server, the SBC 5x00 does standard
route.
% set global servers enum ENUM_S defaultTreatment
routeasdialed
5. To match the criteria:
4–36
Servers
Global
% set global country 1 listOfNumberOfDigitsToMatch
criteria 10,6,3,0
6. To see the ENUM configuration:
% show global servers
% show profiles digitParameterHandling
numberTranslationCriteria
ENUM1
Configuring E911 Server
To create a E911 Server, use the command:
// Mandatory parameters required to configure E911 server.
% set global servers e911 <e911>
// Non-mandatory parameters that can be used to configure E911 server.
% set global servers e911 <e911>
criteria <criteria>
flags <flags>
routePrecedence <routePrecedence>
vpcDevice <vpcDevice>
% set global servers e911VpcDevice <e911VpcDevice>
deviceData <callPriority>
portNumber <portNumber>
% show global servers e911
criteria <criteria>
triggerCriteria <triggerCriteria>
applyFinalTreatment <applyFinalTreatment>
routeAsDialed <routeAsDialed>
flags <flags>
active <active>
4–37
Global
Servers
local <local>
lro <lro>
routePrecedence <routePrecedence>
vpcDevice <vpcDevice>
% delete global servers e911
TABLE 4–10 E911 Server Parameters
Parameter
Field
Length
Description
e911
N/A
defaultTreat N/A
ment
Specifies the name of the E911 server.
Select the default treatment:
• applyFinalTreatment
• routeAsDialed
criteria
N/A
The trigger criteria.
flags
N/A
Specifies E911 server flag.
• disable - Prevents this server from being used.
• enable - Activates the use of this server.
requestTimeO N/A
ut
Specifies the request timeout value. Must be 0-2147483647.
routePreced
ence
N/A
vpcDevice
N/A
callPriorit
y
0-32767 Set the priority level of this service, in the range of 0 to
32767, with 0 having the highest priority.
ipAddress
N/A
Enter the IPv4 address.
portNumber
N/A
Specify the port number. Must be 0-32767.
4–38
The route precedence of the e911 server.
• local
• lro
Specifies the VPC device name for e911 server. This
parameter is used to define E911 VoIP Positioning Center
device data for the SBC 5x00 to use for queries to one or
more E911 VPCs for the Emergency Services Routing
Number of the Public Services Answering Point nearest the
current location of the caller.
Servers
Global
TABLE 4–10 E911 Server Parameters (Continued)
Parameter
Field
Length
e911VpcDevic N/A
e
deviceData
Description
Specifies the E911 VPC Device.
N/A
Specifies the e911 VPC device data.
displaylevel 1-64
commands.
Command Example
Configuring E911 server
To configure E911 server, execute the following CLI commands:
% set global country 1 listOfNumberOfDigitsToMatch criteria
10,6,3,0
% commit
numberTranslationCriteria DEFAULT_E911 none Sonus_NULL
Sonus_NULL 4451211022 1 lookupType e911
% set global servers e911 DEFAULT_E911 flags active enable
% set global servers e911VpcDevice DEFAULT_E911 deviceData 0
ipAddress 10.6.30.137 portNumber 9000
% set global servers e911 DEFAULT_E911 vpcDevice
DEFAULT_E911
% set global servers e911 DEFAULT_E911 criteria
triggerCriteria DEFAULT_E911
% commit
4–39
Global
Signaling
Signaling
These sections describe the configuration objects used for signaling. The following
diagram shows signaling configuration.
FIGURE 4–2 Signaling Configuration
Configuring Gateway Signaling Timers
This object allows you to configure the signaling timers for the gateway.
To create gateway signaling timers, use the command:
% set global signaling gwSigTimers
congRelDelay <congRelDelay>
establish <establish>
idle <idle>
keepalive <keepalive>
retry <retry>
4–40
Signaling
Global
% show global signaling gwSigTimers
congRelDelay <congRelDelay>
idle <idle>
keepalive <keepalive>
retry <retry>
% delete global signaling gwSigTimers
Command Parameters
TABLE 4–11 Gateway Signaling Timers Parameters
Parameter
Field
Length
Description
congRelDelay N/A
Specifies the amount of time (in seconds) that a call which is
rejected due to congestion will be delayed before the
release is issued. Default value is 0 seconds.
displaylevel 1-64
commands.
establish
N/A
Specifies the Gateway Signal Channel Establishment Timer
(in seconds.) This value applies to all signal channels.
Default value is 10 seconds.
idle
N/A
Specifies the amount of time (in hours) a GW Signaling Link
May be idle before it is taken down. Default is 0 hours.
keepalive
N/A
Specifies the Gateway Signal Channel Keepalive Timer (in
seconds.) This value applies to all signal channels. Default
is 3 seconds.
retry
N/A
Specifies the amount of time (in minutes) the SBC 5x00 will
continue to attempt to recover a GW Signaling Link as long
as there are stable calls up. Default value is 60 seconds.
displaylevel 1-64
commands.
4–41
Global
Signaling
Configuring H323 Signaling Timers
This object allows you to configure signaling timers for the node.
To create signaling timers, use the command:
% set global signaling h323SigTimers
t301 <T301>
t302 <T302>
t303 <T303>
t304 <T304>
t310 <T310>
tcpConnect <tcpConnect>
% show global signaling h323SigTimers
t301 <t301>
t302 <t302>
t303 <t303>
t304 <t304>
t310 <t310>
tcpConnect <tcpConnect>
% delete global signaling h323SigTimers
Command Parameters
TABLE 4–12 h323SigTimers Parameters
Parameter
Field
Length
Description
establish
0-127
T301
0-65535 Specifies the T301 call timer (in seconds). Default value is
180 seconds.
T302
0-127
Specifies the T302 call timer (in seconds). Default value is
15 seconds.
T303
0-127
Specifies the T303 call timer (in seconds). Default value is 4
seconds.
4–42
Specifies the H225 signal channel establishment timer (in
seconds). Default value is 4.
Signaling
Global
TABLE 4–12 h323SigTimers Parameters (Continued)
Parameter
Field
Length
T304
0-127
displaylevel 1-64
Description
20 seconds.
commands.
T310
0-127
10 seconds.
tcpConnect
0-127
Specifies the TCP connect timer (in seconds). Default value
is 3 seconds.
Command Example
To display the global configuration of all h323SigTimers:
% show global signaling h323SigTimers
establish
33;
tcpConnect 77;
t301
444;
t302
33;
t303
22;
t304
33;
t310
33;
Configuring SIP Peer Overload Control
This object allows you to configure SIP Peer Overload parameters.
To create SIP Peer Overload parameters, use the command:
% set global signaling sipPeerOverloadControl
discardPeriod <discardPeriod>
rejectThreshold <rejectThreshold>
samplingPeriod <samplingPeriod>
stepDownGain <stepDownGain>
% show global signaling sipPeerOverloadControl
discardPeriod <discardPeriod>
rejectThreshold <rejectThreshold>
samplingPeriod <samplingPeriod>
4–43
Global
Signaling
stepDownGain <stepDownGain>
% delete global signaling sipPeerOverloadControl
Command Parameters
TABLE 4–13 sipPeerOverloadControl Parameters
Parameter
Field
Length
Description
discardPeri
od
1-10
Specifies the discard period (in seconds) for the Peer
Overload backoff algorithm. Default value is 2 seconds.
rejectThres
hold
0-50
Specifies the reject threshold (in rejects/sec) for the Peer
samplingPer
iod
1-10
Specifies the sampling period (in seconds) for the Peer
stepDownGai
n
1-200
Specifies the step down gain for the Peer Overload backoff
algorithm. Default value is 100 seconds.
displaylevel 1-64
commands.
Command Example
To display the global configuration of all SIP overload control:
% show global signaling sipPeerOverloadControl
samplingPeriod
2;
discardPeriod
1;
stepDownGain
44;
rejectThreshold 33;
Configuring SIP Signaling Controls
This object allows you to configure SIP signaling parameters.
To create SIP signaling control parameters, use the command:
% set global signaling sipSigControls
egressRNParam <egressRNParam>
loopDetectionFeature <loopDetectionFeature>
4–44
Signaling
Global
maxPduSizeState <maxPduSizeState>
multipleContactsPerAor <multipleContactsPerAor>
registrarSupportContactParam <registrarSupportContactParam>
suppressErrorInfoHdr <suppressErrorInfoHdr>
% show global signaling sipSigControls
egressRNParam <egressRNParam>
loopDetectionFeature <loopDetectionFeature>
maxPduSizeState <maxPduSizeState>
multipleContactsPerAor <multipleContactsPerAor>
registrarSupportContactParam <registrarSupportContactParam>
suppressErrorInfoHdr <suppressErrorInfoHdr>
% delete global signaling sipSigControls
Command Parameters
TABLE 4–14 SIP signaling control Parameters
Parameter
Field
Length
egressRNPara N/A
m
Description
Specifies egress RN parameter. Specifies whether the SBC
5x00 sends a Redirecting Number Information Element
(RNIE) in the egress leg of the call per RFC3398 when the
R-URI and the To header differ:
• enabled (default) - SBC 5x00 sends a RNIE in the egress leg
of the call as per RFC3398 when the R-URI and the To header
differ.
• disabled - Does not map ingress RN (OCN) to egress call
leg.
loopDetectio N/A
nFeature
Specifies whether or not the SIP Stack will perform loop
detection on incoming INVITE messages.
• enabled (default) - SIP Stack performs loop detection on
incoming INVITE messages.
• disabled - Do not perform loop detection on incoming INVITE
messages but rather allow the SIP signaling group to process
the INVITE message.
4–45
Global
Signaling
TABLE 4–14 SIP signaling control Parameters (Continued)
Parameter
Field
Length
maxPduSizeVa N/A
lue
Description
Specifies the maximum PDU size that will be recognized by
the SBC 5x00 software:
• pdusize2kb - 2048 bytes
• pdusize3kb - 3072 bytes
• pdusize6kb (default) - 6000 bytes
multipleCon
tactsPerAor
N/A
Specifies the multiple contacts per Address Of Record
(AoR).
• enabled - Multiple contacts per Address of record are
supported.
• disabled (default) - Only a single contact per Address of
Record is supported.
registrarSup N/A
portContactP
aram
Specifies whether a Registrar supports parameters in the
Contact header:
suppressErro
rInfoHdr
Specifies whether or not the Error-Info header will be
suppress in a response to a request message with syntax
error.
• enabled (default) - parameters in the Contact header are
supported.
• disabled - parameters in the Contact header are not
supported. This value is provided only for backwards
compatibility.
• enabled - SBC 5x00 will not include Error-Info header in an
error status.
• disabled (default) - SBC 5x00 will include Error-info header in
the response.
displaylevel 1-64
commands.
Command Example
To display the global configuration of all SIP signaling control parameters:
% show global signaling sipSigControls
loopDetectionFeature
enabled;
registrarSupportContactParam enabled;
4–46
suppressErrorInfoHdr
disabled;
maxPduSizeValue
pdusize6kb;
multipleContactsPerAor
enabled;
egressRNParam
disabled;
SIP Domain
Global
SIP Domain
The global SIP domain object allows you to configure the domain name for the
carrier.
Command Syntax
% set global sipDomain <sipDomainName>
% show global sipDomain
% delete global sipDomain <sipDomain>
Command Parameters
TABLE 4–15 SIP Domain Parameters
Parameter
sipDomainNa
me
Field
Length
0-23
displaylevel 1-64
Description
Specifies the SIP domain name. Used to identify the regional
domain name assigned to the carrier. It is used as the
default regional domain name for all the trunk groups that
belong to the carrier. For carrier details, refer "Carrier" on
page 4–22.
commands.
Command Example
To display the global configuration of all SIP domain names:
% show global sipDomain
sipDomain sipDomain1 {
sipDomain sipDomain2;
nonLocal
disable;
}
4–47
Global
Subscriber
Subscriber
The global subscriber object allows you to configure the numerical ID and the
characteristics of subscribers. You can provision groups of subscribers by partial
phone numbers (for example, 978, 617724). The script names referenced must
be in the Script table to enable the associated services.
Command Syntax
% set global subscriber <subscriber> <country>
<owningCarrier>
packetServiceProfile <packetServiceProfile>
services classOfService <classOfService>
% show global subscriber <subscriber> country>
<owningCarrier>
services classOfService <classOfService>
% delete global subscriber <subscriber>
Command Parameters
TABLE 4–16 Subscriber Parameters
Parameter
Field
Length
Description
subscriber
0-31
Specifies a unique identifier for Subscriber.
The subscriber number digit length included must be
identified in the Calling National Id Matching field in the
Country table to make sure that the appropriate Subscriber
is used. For more information, refer to "Country" on page 4–
24.
country
0-15
Specifies the country in which the subscriber resides.
owningCarri
er
0-23
Specifies a 3 or 4-digit Carrier ID number that represents the
Carrier who owns the subscriber. Each Carrier can have
specific services configured for Subscriber calling numbers.
For more information, refer to "Carrier" on page 4–22.
4–48
Subscriber
Global
TABLE 4–16 Subscriber Parameters (Continued)
Parameter
Field
Length
Description
packetServi
ceProfile
0-23
Specifies that the packet service profile is used to override
the IP trunk groups packet service profile.
classOfServ
ice
0-23
This parameter assigns a Class of Service to the Subscriber.
displaylevel 1-64
commands.
Command Example
To display the global subscriber names:
% show global subscriber
subscriber John Japan 1 {
packetServiceProfile packt2;
services {
classOfService cos2;
}
}
subscriber Keith India 1 {
packetServiceProfile pktsrv2;
services {
classOfService 2;
}
}
4–49
Global
4–50
Subscriber
CHAPTER 5
Operations and Maintenance (OAM)
The operations and maintenance (OAM) contains the objects that are applicable
to maintain SBC 5x00. This chapter discusses the means available to manage day-to-day
SBC 5x00 operations. Topics include:
•
•
•
•
•
•
"Accounting" on page 5–2
"Alarms" on page 5–16
"Event Log" on page 5–19
"Local Authentication" on page 5–28
"SNMP" on page 5–31
"Traps" on page 5–33
5–1
Accounting
Accounting
The accounting object controls call related accounting data and the final
destination for the accounting records. SBC 5x00 supports the following as
possible destinations for the accounting records: - Are both the options supported
concurrently?
1. An external server cdrServer - SBC 5x00 will transfer accounting records via
SFTP if writing records to an external server is enabled. In SBC 5x00 the
CDR file roll is controlled through evLog configuration based on file size and
time interval. Depending on the application, you can set a low roll interval in
order to transfer the files to the remote server.
2. Radius accounting server - Accounting records can also be written to an
external radius accounting server.
You can configure SBC 5x00 accounting object using the following options:
•
•
•
•
admin - To setup CDR call configuration. For more information, refer to
"Configuring Call CDR" on page 5–2.
cdrServer - To transfer files to external CDR server. For more information,
refer to "Configuring External CDR Server" on page 5–7.
radius - To transfer files to external radius server. For more information, refer
to "Configuring Radius Server" on page 5–10.
local server disk – Records are always written to local disk.
The following sub sections explain CLI details.
Configuring Call CDR
To setup CDR call configuration, use the following command syntax.
Command Syntax
% set oam accounting admin
earlyAttemptState <earlyAttemptState>
generationMode <generationMode>
intermediateAcctInterval <intermediateAcctInterval>
intermediateAcctMode <intermediateAcctMode>
intermediateAcctState <intermediateAcctState>
intermediateLongDurGenTime <intermediateLongDurGenTime>
intermediateLongDurThreshold
<intermediateLongDurThreshold>
intermediateTrapState <intermediateTrapState>
maxRecordSequenceNum <maxRecordSequenceNum>
5–2
Accounting
populateIpTgFarEndSwitchType
<populateIpTgFarEndSwitchType>
populateNonPortedLnpNumbers <populateNonPortedLnpNumbers>
populateRemoteGsxInfoState <populateRemoteGsxInfoState>
secondStageInheritFirstStage <secondStageInheritFirstStage>
sendEgressCdrInfoOnReceipt <sendEgressCdrInfoOnReceipt>
startAcctState <startAcctState>
% show oam accounting admin
earlyAttemptState <earlyAttemptState>
generationMode <generationMode>
intermediateAcctInterval <intermediateAcctInterval>
intermediateAcctMode <intermediateAcctMode>
intermediateAcctState <intermediateAcctState>
intermediateLongDurGenTime <intermediateLongDurGenTime>
intermediateLongDurThreshold
<intermediateLongDurThreshold>
intermediateTrapState <intermediateTrapState>
maxRecordSequenceNum <maxRecordSequenceNum>
populateIpTgFarEndSwitchType
<populateIpTgFarEndSwitchType>
populateNonPortedLnpNumbers <populateNonPortedLnpNumbers>
populateRemoteGsxInfoState <populateRemoteGsxInfoState>
secondStageInheritFirstStage <secondStageInheritFirstStage>
sendEgressCdrInfoOnReceipt <sendEgressCdrInfoOnReceipt>
startAcctState <startAcctState>
5–3
Accounting
Command Parameters
TABLE 5–1
Parameter
CDR Admin Parameters
Field
Length
earlyAttempt N/A
State
Description
Specifies whether or not to generate early ATTEMPT
records. An early ATTEMPT record is associated with an
early call disconnect, before the request is sent. Options are:
• enabled (default) - Do not generate early ATTEMPT records.
• disabled - Generate early ATTEMPT records.
generationMo N/A
de
Specifies the type of calls for which accounting records
should be logged on this SBC 5x00. Options are:
• orignation (default) - Log accounting records for which this
SBC 5x00 is the originating gateway.
• destination - Log accounting records for which this SBC
5x00 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.
intermediate N/A
AcctInterval
Specifies the Intermediate Accounting Interval in seconds.
NOTE
This object is only applicable
when sonusAcctIntAcctMode is
set to interval(1).
intermediate N/A
AcctMode
Specifies the method by which intermediate records are
generated. Options are:
• interval (default) - Generate an intermediate record for each
intermediateAcctInterval seconds throughout the call.
• telcordia - Generate an intermediate record whenever the
call exceeds the configured
intermediateLongDurThreshold value (in hours) and the
intermediateLongDurGenTime (of day) is reached.
intermediate N/A
AcctState
Specifies whether Intermediate Accounting is Enabled or
Disabled for the Node. Options are:
• enabled - When enabled, INTERMEDIATE Accounting
Records will be generated for calls that have been stable for a
duration exceeding the intermediate account interval.
• disabled - When disabled, INTERMEDIATE Accounting
Records will not be generated for calls.
5–4
Accounting
TABLE 5–1
Parameter
CDR Admin Parameters (Continued)
Field
Length
intermediate N/A
LongDurGenTi
me
Description
Specifies Octet string that identifies the GMT time to
generate Telcordia Long Duration accounting records.
The format is 00:00:00.0. Where each field range is:
field
octets contents
---- ---- ------
range
----
1
1
hour
0..23
2
2
minutes
0..59
3
3
seconds
0..60(use 60 for leap-second)
4
4
deci-seconds
0..9>[00:00:00.0]
intermediate N/A
LongDurThres
hold
Specifies the Accounting INTERMEDIATE Records Duration
(in hours). Must be 1-24; default is 24. This parameter is
only applicable when intermediate records mode is set to
telcordia. The INTERMEDIATE record is generated for each
call whose duration exceeds this threshold on long duration
generation time.
intermediate N/A
TrapState
Specifies whether a trap will be generated whenever an
INTERMEDIATE record is generated. Options are:
• enabled - When enabled, a trap will be generated whenever
an INTERMEDIATE record is generated.
• disabled - When disabled, a trap will not be generated
whenever an INTERMEDIATE record is generated.
maxRecordSeq N/A
uenceNum
Specifies the maximum length of the Record Sequence
Number field in the CDR. Options are:
• uint16 (default) - 16-bit record sequence number 0 to 65535.
• uint32 - 32-bit record sequence number 0 to 4294967295.
populateIpTg N/A
FarEndSwitch
Type
Specifies whether or not to use Ingress Far End Switch Type
passed down from PSX IP Trunkgroup for SIP ingress calls.
Options are:
• enabled
• disabled
populateNonP N/A
ortedLnpNumb
ers
Specifies whether or not to populate the Called Number
Before Translation field in the accounting record for a
number for which an LNP lookup was performed and the
lookup indicated that the number has not been ported.
Options are:
• false
• true
populateRemo N/A
teGsxInfoSta
te
Specifies whether a destination SBC 5x00 propagates its
billing data to originating SBC 5x00 for GW-GW calls.
Options are:
• enabled
• disabled
5–5
TABLE 5–1
Accounting
CDR Admin Parameters (Continued)
Parameter
Field
Length
secondStageI N/A
nheritFirstS
tage
Description
Specifies whether or not second stage accounting records
for two stage calls inherit fields from the first stage call.
Options are:
• false
• true
sendEgressCd N/A
rInfoOnRecei
pt
Specifies whether or not to send the egress CDR
information immediately after receiving and processing it.
Options are:
• false
• true
startAcctSta N/A
te
Specifies whether Start Accounting is Enabled or Disabled
for the Node. Options are:
• enabled - When enabled, START accounting records will be
generated for successful call attempts.
• disabled - When disabled, START accounting records will
not be generated for successful call attempts.
displayleve
l
1-64
commands.
Command Example
To configure CDR administration:
% set oam accounting admin earlyAttemptState enabled
generationMode destination intermediateAcctInterval 20
intermediateAcctMode telcordia intermediateAcctState
enabled intermediateLongDurGenTime 02:03:04.2
intermediateLongDurThreshold 2 intermediateTrapState
enabled maxRecordSequenceNum uint16
populateIpTgFarEndSwitchType enabled
populateNonPortedLnpNumbers true
populateRemoteGsxInfoState enabled
secondStageInheritFirstStage true
sendEgressCdrInfoOnReceipt true startAcctState enabled
To display configured CDR administration details:
% show oam accounting admin
generationMode
destination;
intermediateAcctState
enabled;
intermediateAcctInterval
20;
secondStageInheritFirstStage true;
5–6
populateNonPortedLnpNumbers
true;
intermediateAcctMode
telcordia;
Accounting
intermediateLongDurGenTime
02:03:04.2;
startAcctState
enabled;
intermediateTrapState
enabled;
populateRemoteGsxInfoState
enabled;
earlyAttemptState
enabled;
intermediateLongDurThreshold 2;
sendEgressCdrInfoOnReceipt
true;
populateIpTgFarEndSwitchType enabled;
maxRecordSequenceNum
uint16;
Configuring External CDR Server
To configure SBC 5x00 accounting object to transfer files to external CDR server,
use the following command syntax.
Command Syntax
% set oam accounting cdrServer admin [primary | secondary]
filePrefix <filePrefix>
password <password>
path <path>
username <username>
% show oam accounting cdrServer
admin
% show oam accounting cdrServer admin [primary | secondary]
filePrefix <filePrefix>
password <password>
path <path>
username <username>
% delete oam accounting cdrServer admin
% request oam accounting cdrServer admin primary
5–7
Accounting
forceCurrentServer <forceCurrentServer>
resetCdrServerStats <resetCdrServerStats>
Command Parameters
TABLE 5–2
External CDR Server Parameters
Parameter
Field
Length
filePrefix
N/A
Specifies the remote file prefix that is used to form the
remote file. This prefix will be appended with a date stamp
and sequence number once transferred.
ipAddress
N/A
Specifies the IP Address of the external CDR server. The
Description
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
password
N/A
Specifies the remote server password.
NOTE
The password will be echoed in
hidden text when prompted for
entry. It is recommended that it
should not be entered inline.
path
N/A
Specifies the remote directory path where the files should be
transferred.
username
N/A
Specifies the remote username.
displayleve
l
1-64
commands.
forceCurren
tServer
N/A
Use this request parameter to forcibly set the specified
server as the current server.
resetCdrSer
verStats
N/A
Use this request parameter to reset the CDR server
statistics.
Command Example
To display the configured CDR server details:
% show oam accounting cdrServer admin
5–8
Accounting
admin primary {
ipAddress
10.34.26.151;
username
user1;
password
$3$/eZMV4pggus=;
path
/temp/test1;
filePrefix TestCDR_file2;
}
To display the complete status of CDR details:
% show table oam accounting cdrServer status
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
------------------------------------------------------------primary
active
secondary standby
idle
2
1
0
idle
0
7
0
To configure CDR server actions:
> request oam eventLog cdrServerAdmin secondary
forceCurrentServer
[ok][2010-07-27 04:10:00]
> show table oam accounting cdrServer status
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
-----------------------------------------------------------------primary
standby
idle
2
0
0
secondary
active
idle
0
7
0
[ok][2010-07-27 04:12:36]
>
> request oam eventLog cdrServerAdmin secondary
resetCdrServerStats
[ok][2010-07-27 04:14:33]
>
> show table oam accounting cdrServer status
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
-----------------------------------------------------------------primary
standby
idle
2
0
0
secondary
active
idle
0
0
0
To configure event log roll interval:
> configure
[ok][2010-07-15 09:08:25]
5–9
Accounting
[edit]
% set oam eventLog typeAdmin acct rolloverInterval 60
rolloverType repetitive
[ok][2010-07-15 09:09:07]
[edit]
% set oam eventLog typeAdmin acct rolloverStartTime
<dateTime (CCYY-MM-DDTHH:MM:SS)>
% set oam eventLog typeAdmin acct rolloverStartTime 2010-0715T09:12:00
[ok][2010-07-15 09:09:49]
[edit]
% set oam eventLog typeAdmin acct rolloverAction start
[ok][2010-07-15 09:10:00]
[edit]
% commit
Commit complete.
[ok][2010-07-15 09:10:02]
Configuring Radius Server
The radius object allows you to configure the RADIUS client for transporting of call
accounting information from SBC 5x00 to a RADIUS sever.
The RADIUS server is used to record the usage information. The accounting
request from the radius server contains information related to usage of resource
controlled by the NAS. This usage information is stored by RADIUS server and
later used for billing the user.
Configuring Radius Server for Accounting
Command Syntax
%
set oam accounting radius accountingAdmin
failoverPolicy <failoverPolicy>
maxErrorRate <maxErrorRate>
maxNoResponseTime <maxNoResponseTime>
5–10
Accounting
maxPacketRetryCount <maxPacketRetryCount>
maxQueuedPacketsInMemory <maxQueuedPacketsInMemory>
nasIdentifier <nasIdentifier>
nasIpAddress <nasIpAddress>
sendNasIdentifier <sendNasIdentifier>
sendNasIpAddress <sendNasIpAddress>
state <state>
% show oam accounting radius accountingAdmin
failoverPolicy <failoverPolicy>
maxErrorRate <maxErrorRate>
maxNoResponseTime <maxNoResponseTime>
maxPacketRetryCount <maxPacketRetryCount>
nasIdentifier <nasIdentifier>
nasIpAddress <nasIpAddress>
sendNasIdentifier <sendNasIdentifier>
sendNasIpAddress <sendNasIpAddress>
state <state>
% delete oam accounting radius accountingAdmin
5–11
Accounting
Command Parameters
TABLE 5–3
Radius Parameters
Parameter
Field
Length
failoverPoli N/A
cy
Description
Specifies the failover policy for the radius servers upon error
detection. Select any one of the option if the currently
chosen RADIUS server has failed as per the server failure
criteria.
• prioritizedSelection - This option searches the first
server in the list of all servers sorted in descending order of
priority and select the first server available with the highest
priority in the list that is not marked as failed.
• roundRobin - This option searches the server having next
lower priority and select the same if the server is not marked as
failed. If the RADIUS server that failed was the last one in the
list of server, selection logic shall loop to the server with highest
priority that is the first server in list of all servers.
maxErrorRate 1-25
Specifies the maximum percentage of timed out transactions
allowed. Default value is 25 percent.
maxNoRespons 1-2000
eTime
Specifies the maximum time allowed to wait for any
response from the server. Default value is 2000
milliseconds.
maxPacketRet N/A
ryCount
Specifies the maximum number of times a packet will be
retransmitted before the packet is dropped. After this
number of retries it is assumed that the Radius Server
rejected the packet, since no provision has been made in
the protocol to send a negative response. Default value is
10.
N/A
Specifies the maximum number of times a packet is
retransmitted before the packet is dropped. Default value is
1000000.
nasIdentifie N/A
r
Specifies the NAS-Identifier to be sent to the radius server.
Enter a value between 1-253.
nasIpAddress N/A
Specifies the NAS IPv4 Address that will be sent to the
Radius Server.
sendNasIdent N/A
ifier
If true, send NAS-Identifier to the radius server. Options are:
maxQueuedPa
cketsInMemo
ry
sendNasIpAdd N/A
ress
5–12
• false - Does not send NAS-Identifier to the radius server.
• true - Sends NAS-Identifier to the radius server.
If true, send NAS-IP-Address to the radius server.
• false - Does not send NAS-IP-Address to the radius server.
• true - Sends NAS-IP-Address to the radius server.
Accounting
TABLE 5–3
Radius Parameters
Parameter
Field
Length
state
N/A
Description
Specifies the administrative state of the radius subsystem.
Options are:
• disabled - When disabled, accounting records will not be
sent to a RADIUS server.
• enabled - When enabled, accounting records will be sent to a
RADIUS server.
displayleve
l
1-64
commands.
Command Example
To display the configuration of radius accounting administration parameters:
% show oam accounting radius accountingAdmin
state
disabled;
nasIpAddress
10.34.26.151;
nasIdentifier
nas2;
maxErrorRate
4;
maxNoResponseTime 3344;
Configuring Radius Server
Command Syntax
// Mandatory parameters required to configure a Radius Server.
% set oam accounting radius radiusServer <radiusServer>
priority <priority>
serverAddress <serverAddress>
sharedSecret <sharedSecret>
state <state>
// Non-manadatory parameters that can be used to configure a Radius Server.
% set oam accounting radius radiusServer <radiusServer>
cleanupDelay <cleanupDelay>
serverPort <serverPort>
% show oam accounting radius radiusServer
5–13
Accounting
cleanupDelay <cleanupDelay>
priority <priority>
serverAddress <serverAddress>
serverPort <serverPort>
sharedSecret <sharedSecret>
state <state>
% delete oam accounting radius radiusServer
Command Parameters
TABLE 5–4
Parameter
Radius Server Parameters
Field
Length
Description
Mandatory parameter descriptions for a Radius server.
radiusServer N/A
priority
1-2000
serverAddres N/A
s
Specifies the name of the radius server.
Specifies the priority for this server.
Specifies the IPv4 or IPv6 IP address of the server as either
a host name or an address in the following notation.
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
sharedSecret N/A
Specifies the shared secret used to authenticate the packet.
NOTE
The sharedSecret has to be same
on the radius server configured in
SBC 5x00 and the external radius
server.
5–14
Accounting
TABLE 5–4
Radius Server Parameters
Parameter
Field
Length
state
N/A
Description
Specifies the administrative state of the radius server.
Options are:
• disabled - When disabled, the RADIUS server does not
records the usage information.
• enabled - When enabled, the RADIUS server records the
usage information. The accounting request from the radius
server contains information related to usage of resource
controlled by the NAS. This usage information is stored by
RADIUS server and later used for billing the user.
Non-mandatory parameter descriptions for a Radius server
cleanupDelay 1-25
Specifies the time for which the radius server maintains the
received requests after they are acknowledged, so that
retries set to the server can be detected.
serverPort
N/A
Specifies the IP port used to send requests to the radius
server.
displayleve
l
1-64
commands.
Command Example
To display the configuration of radius server parameters:
% show oam accounting radius radiusServer
radiusServer radiusserver2 {
priority
4;
state
enabled;
serverAddress Customer1Host;
serverPort
3033;
sharedSecret
3;
cleanupDelay
2;
}
To check the status of the radius server:
% show table oam radius radiusServerStatus
SERVER
NAME
SERVER TOTAL
STATUS REQUESTS
TIMED
REQUEST ERROR OUT
RATE
RATE
REQUESTS
RESPONSES
REJECTED SPURIOUS
WITH
REQUESTS RESPONSES ATTRIBUTES
5–15
Alarms
Alarms
The alarms object allows you to configure parameters for alarms which are
individually configurable.
NOTE
Link detection failure alarms are generated by Link Verification
Manager (LVM) and are raised only when LVM is configured. NRS
generated alarms must be raised even if the LVM is configured or not.
NOTE
Most alarms do not require any user configuration and hence are not
included in this section. Refer to SBC 5x00 Alarms and Troubleshooting
Guide for complete list of available alarms and details.
Command Syntax
% set oam alarms ipPolicingAlarmAdmin
majorAlarmMode <majorAlarmMode>
majorAlarmProfileName <majorAlarmProfileName>
minorAlarmMode <minorAlarmMode>
minorAlarmProfileName <minorAlarmProfileName>
% show oam alarms
ipPolicingAlarmAdmin
% show oam alarms ipPolicingAlarmAdmin
majorAlarmProfileName <majorAlarmProfileName>
minorAlarmProfileName <minorAlarmProfileName>
% delete oam alarms ipPolicingAlarmAdmin
5–16
Alarms
% request alarms clear current alarmId <alarmId>
% request alarms clear history
% request oam alarms resetIpPolicingAlarmStatus
Command Parameters
TABLE 5–5
IP Policing Alarm Parameters
Parameter
Field
Length
majorAlarmMo N/A
de
Description
Specifies the Maintenance/service mode for major alarm
notification.
• inService - Able to be triggered.
• outOfService (default) - Not active.
majorAlarmPr N/A
ofileName
Specifies the name of the policer alarm profile for major
alarm notification.
• defaultSystemMajor
• defaultSystemMinor
minorAlarmMo N/A
de
Specifies the Maintenance/service mode for minor alarm
notification.
• inService - Able to be triggered.
• outOfService (default) - Not active.
minorAlarmPr N/A
ofileName
Specifies the name of the policer alarm profile for minor
alarm notification.
• defaultSystemMajor
• defaultSystemMinor
displayleve
l
1-64
commands.
Command Example
To display the mode and profile name of major and minor alarms of IP policer
alarm:
% show oam alarms ipPolicingAlarmAdmin
minorAlarmMode
outOfService;
majorAlarmMode
inService;
minorAlarmProfileName defaultSystemMinor;
majorAlarmProfileName defaultSystemMajor;
5–17
TABLE 5–6
Alarms
Alarm Request Parameters
Parameter
Field
Length
Description
alarmId
N/A
Specifies that a current-outstanding alarm has to be cleared.
5–18
Event Log
Event Log
This object allows you to create and configure log files that capture debug,
security, system, trace, and accounting events.
Event Log Filters
You can filter alarms based on the following:
•
•
•
filterAdmin - To filter administration alarms.
subsystemAdmin - To filter specific subsystem alarms. For example, you
can filter specific card card1hlthchk, or port card2portmon related
alarms.
typeAdmin - To filter account, audit, debug, packet, security,
system, and trace alarms.
Command Syntax
// Mandatory parameters required to configure an Event log filter admin.
% set oam eventLog filterAdmin <systemname> <eventType>
<specificEvent>
// Non-mandatory parameters that can be used to configure an Event log filter
admin
% set oam eventLog filterAdmin level <level> state <state>
// Mandatory parameters required to configure an Event log subsystem event
type.
% set oam eventLog subsystemAdmin <systemname>
<subsystemAdmin_eventType>
// Non-mandatory parameters that can be used to configure an Event log
subsystem event type.
% set oam eventLog subsystemAdmin <infoLogState>
<maxEventId> <minEventId>
% set oam eventLog typeAdmin <eventType>
<eventType>: acct, audit, debug, packet, security, system,
trace
fileCount <fileCount>
fileSize <fileSize>
fileWriteMode <fileWriteMode>
filterLevel <filterLevel>
messageQueueSize <messageQueueSize>
5–19
Event Log
rolloverAction <rolloverAction>
rolloverInterval <rolloverInterval>
rolloverStartTime <rolloverStartTime>
rolloverType <rolloverType>
saveTo <saveTo>
state <state>
syslogRemoteHost <syslogRemoteHost>
syslogRemotePort <syslogRemotePort>
syslogRemoteProtocol <syslogRemoteProtocol>
syslogState <syslogState>
% show oam eventLog <filterType>
filterAdmin <filterAdmin>
subsystemAdmin <systemname>
typeAdmin <typeAdmin>
% show details oam eventLog <filterType>
% show oam eventLog filterAdmin
level <level>
state <state>
% show oam eventLog subsystemAdmin
infoLogState <infoLogState>
maxEventId <maxEventId>
minEventId <minEventId>
% show oam eventLog typeAdmin <eventType>
acct <account>
audit <audit>
debug <debug>
packet <packet>
security <security>
system <system>
trace <trace>
% delete oam eventLog <filterType>
5–20
Event Log
% request oam eventLog filterStatus systemname <eventType>
% request oam eventLog filterStatus <systemname> system
trace resetStats
Command Parameters
TABLE 5–7
FilterAdmin Event Log Parameters
Parameter
Field
Length
Description
filterAdmin
N/A
Specifies the Event Log Class Filter configuration table per
card.
systemName
N/A
Specifies the SBC 5x00 system name.
eventType
N/A
Specifies the type of event log being configured:
• acct - System account log data. These files have .ACT
extensions.
• audit - System audit data. These files contain a record of all
management interactions that modify the state of the system.
These files have .AUD extensions. It includes all the changes
made via the CLI and the Netconf interface.
• debug - System debugging data. These files have .DBG
extensions.
• packet - Packet information details. These files have .PKT
extensions. If enabled, stores the packet details to .PKT files.
• system - System level events. These files have .SYS
extensions.
• security - Security level events. These files have .SEC
extensions.
• trace - System trace data. These files have .TRC extensions.
specficEvent
For each eventType, configure one of the following event:
•
•
•
•
•
•
•
•
•
•
callproc - Specifies the Call Processing subsystem.
directory - Specifies the Directory Services subsystem.
netmgmt - Specifies the Network Management subsystem.
policy - Specifies the Policy subsystem.
resmgmt - Specifies the Resource Management subsystem.
routing - Specifies the Network Routing subsystem.
security - Specifies the Security subsystem.
signaling - Specifies the Signaling subsystem.
sysmgmt - Specifies the System Management subsystem.
trace - Specifies the Call Trace subsystem.
5–21
TABLE 5–8
Event Log
subsystemAdmin Event Log Parameters
Parameter
Field
Length
Description
filterType
N/A
Specifies the type of the alarm filter being configured.
• filterAdmin - Event Log Class Filter configuration table per
card.
• subsystemAdmin - Subsystem Event Logging configuration
table.
• typeAdmin - Event Log configuration table for configuration
items related to each Event Log type.
subsystemAdm N/A
in_eventType
Specifies the type of sub system administration event log
being configured:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
5–22
acm
arma
asg
atmrm
brm
cam
cassg
cc
chm
cli
cmtsg
cnh
cpx
dbug
diamc
dnsc
drm
ds
ema
enm
fm
frm
grm
gwfe
gwsg
h248fe
h323fe
h323sg
icmsvc
ike
im
Event Log
TABLE 5–8
Parameter
subsystemAdmin Event Log Parameters (Continued)
Field
Length
subsystemAdm N/A
in_eventType
Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
ipacl
ipm
lvm
m3uanif
mgsg
mtp2
mtrm
nbsapp
ncm
ncomm
nim
nrm
nrma
nrs
ntp
pathchk
pes
pfa
pipe
pipehook
prm
reserved
rtcp
rtm
scpa
sec
sfm
sg
sgisdn
sgisup
sipfe
sipsg
sm
sma
ssa
trm
xrm
Non-mandatory parameter descriptions.
5–23
TABLE 5–8
Event Log
subsystemAdmin Event Log Parameters (Continued)
Parameter
Field
Length
level
N/A
Description
Specifies the minimum severity that warrants the logging of
an event of this type:
•
•
•
•
•
state
N/A
critical - log only events of this threshold.
info - log every possible event.
major - log major and critical events only.
minor - log all events other than info.
noevents - do not log any events.
Specifies the administrative state of event logging for this
event type:
• off - Logging is not activated.
• on - Logging is activated.
infoLogState N/A
Specifies the subsystem's INFO level event logging state.
Options are:
• disabled - When disabled, INFO level messages will not be
logged to the DBG and SYS logs for the given subsystem.
• enabled - When disabled, INFO level messages will be
logged to the DBG and SYS logs for the given subsystem.
maxEventId
N/A
Specifies the subsystem's maximum event ID that do not get
filtered.
minEventId
N/A
Specifies the subsystem's minimum event ID that do not get
filtered.
5–24
Event Log
TABLE 5–9
typeAdmin Event Log Parameters
Parameter
Field
Length
typeAdmin
N/A
Specifies the event Log configuration table for configuration
items related to each Event Log type.
eventType
N/A
Specifies the type of event log being configured:
Description
• acct - System account data. These files have .ACT extensions.
• audit - System audit data. These files contain a record of all
management interactions that modify the state of the system.
These files have .AUD extensions. It includes all the changes
made via the CLI and the Netconf interface.
• debug - System debugging data. These files have .DBG
extensions.
• packet - Packet information details. These files have .PKT
extensions. If enabled, stores the packet details to .PKT files.
• security - Security level events. These files have .SEC
extensions.
• system - System level events. These files have .SYS
extensions.
• trace - System trace data. These files have .TRC extensions.
fileCount
1-1024
Specifies the number of event log files that will be
maintained for this event type. Default is 32.
fileSize
25665535
Specifies the maximum size (in KB) that a single event log
file will ever grow to. Default is 2048 KB.
fileWriteMod N/A
e
filterLevel
N/A
Specifies the event log NFS write mode. Options are:
• default - Log data is written as a 1344-byte packet.
• optimize - Log data is written as a 8000-byte packet.
Optimize write mode results in IP fragmentation but yields better
throughput.
Specifies the events that are at least as severe as the
designated level will be logged. Options are:
•
•
•
•
•
displayleve
l
1-64
critical - log only events of this threshold.
info - log every possible event.
major - log major and critical events only.
minor - log all events other than information.
noevents - do not log any events.
commands.
maxEventMemo 1-64
rySize
Specifies the maximum size of the memory event log buffer
(in KB). Default is 33 KB.
messageQueue 2-32
Size
Specifies the number of event log message entries to buffer
before writing them to disk. Default is 10 message entries.
5–25
TABLE 5–9
Event Log
typeAdmin Event Log Parameters (Continued)
Parameter
Field
Length
rolloverActi N/A
on
rolloverInte N/A
rval
Description
Specifies the event log rollover actions. Options are:
• start - Start rollover action.
• stop - Stop rollover action.
Specifies the event log rollover interval.
rolloverStar N/A
tTime
CCYY-MM-DDTHH:MM:SS. For example: 2010-01-01T01:01:01
Specifies the start time for event log rollover. The format is:
rolloverType N/A
Specifies the event log rollover type. Options are:
• nonrepetitive - The rollover will occur once at the specified
single instance.
• repetitive - The rollover will occur repeatedly at the
specified intervals.
saveTo
N/A
Specifies that the events have to be saved to memory, disk,
both, or neither.
state
N/A
Specifies the requested state of the given Event Log type.
Options are:
• disabled - Logging is not activated.
NOTE
Accounting logs may never be
disabled.
• enabled - Logging is activated.
syslogRemote N/A
Host
Specifies the remote host where the messages are written to
the syslog.
syslogRemote N/A
Port
Specifies the port to use to send messages to the remote
syslog. Default value is 514.
syslogRemote N/A
Protocol
Specifies the protocol to use to send messages to the
remote syslog. Options are:
• relp
• tcp
• udp
syslogState
N/A
Specifies whether the contents of this log are also written out
to the syslog. Options are:
• disabled - Does not log events of the specified type to the
syslog.
• enabled - Logs events of the specified type to the syslog.
5–26
Event Log
Command Example
To display the admin event log details:
% show details oam eventLog typeAdmin
typeAdmin system {
state
enabled;
fileCount
32;
fileSize
2048;
messageQueueSize
10;
saveTo
both;
maxEventMemorySize
16;
filterLevel
major;
rolloverInterval
0;
rolloverType
nonrepetitive;
rolloverAction
stop;
fileWriteMode
default;
syslogState
disabled;
syslogRemoteHost
host;
syslogRemoteProtocol tcp;
syslogRemotePort
514;
}
To configure event log type, packet:
% set oam eventLog typeAdmin packet fileCount <fileCount>
fileSize <fileSize> rolloverInterval <rolloverInterval>
state <state> syslogState disabled
To request an immediate roll over:
% request oam eventLog typeAdmin packet rolloverLogNow
5–27
Local Authentication
The local authentication object allows you to manage SBC 5x00 local
Authentication and Authorization of users and groups.
Authenticating users/groups
Use the following command syntax to authenticate users/groups.
Command Syntax
% set oam localAuth user <user> group <group>
% show oam localAuth
user <user>
% show oam localAuth user <user>
group <group>
% delete oam localAuth user <user>
5–28
Command Parameters
TABLE 5–10 Local Authentication Parameters
Parameter
Field
Length
Description
user
N/A
Specifies the name of the group user.
group
N/A
Specifies the authentication to user in any one of the
following group:
•
•
•
•
Administrator
FieldService
Guest
Operator
NOTE
When a new user is created,
the default password is set to
password. You must change
the default password. For more
information, refer to "changepassword" on page 2–3.
displaylevel
1-64
commands.
Command Examples
To display the local authentication given to the users and groups:
% show oam localAuth
user User1 {
group Operator;
}
user User3 {
group Administrator;
}
user User4 {
group Operator;
}
user User8 {
group FieldService;}
user admin {
5–29
group Administrator;
}
5–30
SNMP
SNMP
This object defines a SNMP network management station that may send SNMP
requests to and/or receive SNMP trap messages from the SBC 5x00. SNMP traps
are messages that notify a management client that an event has occurred on the
SBC 5x00 node.
In general any event that results in an SNMP trap message is also logged in an
event log (refer to "Event Log" on page 5–19) but only a small subset of events
generate an SNMP trap message.
Command Syntax
% set oam snmp trapTarget <trapTarget>
port <port>
state <state>
trapType <trapType>
% show oam snmp
trapTarget <trapTarget>
% show oam snmp trapTarget <trapTarget>
port <port>
state <state>
trapType <trapType>
% delete oam snmp trapTarget
5–31
SNMP
Command Parameters
TABLE 5–11 SNMP Parameters
Parameter
Field
Length
Description
trapTarget
N/A
Specifies the name of the trap target.
ipAddress
N/A
Specifies the IP address of this trap target.
The following IP address types are supported:
IPv4 - This is V4 IP address in dotted decimal form (for
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
port
N/A
Specifies the port number for SNMP traps. The default port
is 161.
state
N/A
Specifies the configured state of the trap target entry.
Options are:
• disabled - When disabled, no traps are sent to the trap
server.
• enabled - When enabled, traps are sent to the trap server.
trapType
N/A
Specifies the type of the trap sent to the target. Options are:
• v1 - Only SNMPv1 traps will be sent to the trap target server.
• v2 - Only SNMPv2 traps will be sent to the trap target server.
displayleve
l
1-64
commands.
Command Example
To display the configuration of SNMP parameters:
% show oam snmp
trapTarget trapTarget4 {
port
161;
trapType
V1;
state
enabled;
}
5–32
Traps
Traps
This object provides:
•
•
A list of the traps supported by the SBC 5x00. These traps are created at
system initialization time, without CLI control.
A means of enabling and disabling specific traps at the SBC 5x00.
You may use this mechanism to disable specific traps while you reconfigure the
SBC 5x00, reenabling them when you’re done. For example, you may cause the
generation of trap messages as a result of temporarily detaching cables but not
wish to see them at any SNMP network management station.
For a list of all possible traps, use the show oam traps command.
Command Syntax
.
% set oam traps admin <trap> state <state>
% set oam traps dspAdmin callFailureTrap lackdsp
interval <interval>
% set oam traps dspAdmin dspAvailabilityTrap
allThreshold <allThreshold>
g711PacketThreshold <g711PacketThreshold>
g726Threshold <g726Threshold>
g729Threshold <g729Threshold>
% show oam traps
admin <trap>
dspAdmin <trap>
% show oam traps admin <trap> displaylevel <displaylevel>
% show oam traps dspAdmin <trap>
callFailureTrap <callFailureTrap>
lackdsp
5–33
Traps
dspAvailabilityTrap <dspAvailabilityTrap>
allThreshold
g711PacketThreshold
g726Threshold
g729Threshold
5–34
Traps
Command Parameters
TABLE 5–12 Trap Parameters
Parameter
Field
Length
admin
N/A
Specifies the sonusTrapTable identifies the SNMP
notifications that this node supports.
dspAdmin
N/A
Specifies the dsp resource usage trap configuration. You
can configure the following:
Description
• callFailureTrap - Trap configuration for Call Failure due to
no DSP. Specify the following parameters:
interval - Indicates the time interval for the threshold of call
failure due to lack of DSP pad. Enter value in range of 0-21600
in seconds. Default is 333 seconds.
threshold - Indicates the number of call failure due to lack of
DSP pad threshold. Enter value in range of 0-65535. Default is
433.
• dspAvailabilityTrap - DSP Availability trap threshold
configuration. Specify the following parameters:
allThreshold - Indicates the percentage DSP Availability
threshold for all types. Enter value in range of 0-100 in
percentage.
g711PacketThreshold - Indicates the percentage of G711
Packet type DSP Availability threshold. Enter value in range of
0-100 in percentage.
g726Threshold - Indicates the percentage of G726 type DSP
Availability threshold. Enter value in range of 0-100 in
percentage.
g729Threshold - Indicates the percentage of G729 type DSP
Availability threshold. Enter value in range of 0-100 in
percentage.
5–35
Traps
Parameter
Field
Length
Description
trap
NA
Specifies the name of the trap.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
5–36
sonusConnexIpSystemCEFanNormalNotification
sonusCpCdrServerNewXferPendingNotification
sonusCpCdrServerSwtichoverNotification
sonusCpCdrServerTransferFailNotification
sonusCpCdrServerPendingQueueEmptiedNotification
sonusCpConfigCommitFailNotification
sonusCpConfigCommitSucceedNotification
sonusCpEventLogFileClosedNotification
sonusCpEventLogFileCountChngNotification
sonusCpEventLogFileCountNotification
sonusCpEventLogFileCreatedNotification
sonusCpEventLogFileRestartNotification
sonusCpEventLogFileShutdownNotification
sonusCpEventLogFileSizeChngNotification
sonusCpEventLogFileStateNotification
sonusCpEventLogRolloverFastNotification
sonusCpEventLogRolloverStoppedNotification
sonusCpEventLogSaveToChngNotification
sonusCpNodeBondingDeviceDownNotification
sonusCpNodeBondingDeviceUpNotification
sonusCpNodeHaPortDownNotification
sonusCpNodeHaPortUpNotification
sonusCpNodeStandbyDisabled
sonusCpNodeStandbyEnabled
sonusCpNtpAllServersOutOfSyncNotification
sonusCpNtpDownNotification
sonusCpNtpServerInServiceNotification
sonusCpNtpServerInSyncNotification
sonusCpNtpServerOutOfServiceNotification
sonusCpNtpServerOutOfSyncNotification
sonusCpNtpUpNotification
sonusCpRadiusServerFailedNotification
sonusCpRedundGroupSwitchOverNotification
sonusCpSoftwareUpgradeRevertNotification
sonusCpSystemBootActiveNotification
sonusCpSystemBootNotification
sonusCpSystemCEBootActiveNotification
sonusCpSystemCEBootNotification
sonusCpSystemCEDisabledNotification
Traps
Parameter
trap
(continued)
Field
Length
NA
Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
sonusCpSystemCEEnabledNotification
sonusCpSystemCEOperationalNotification
sonusCpSystemCESoftBootActiveNotification
sonusCpSystemCESoftBootNotification
sonusCpSystemCETempFailureNotification
sonusCpSystemCETempNormalNotification
sonusCpSystemCETempWarningNotification
sonusCpSystemLocalDiskSpaceOkNotification
sonusCpSystemSoftBootActiveNotification
sonusCpSystemSoftBootNotification
sonusH248FeatureDisabledNotification
sonusH248FeatureEnableNotification
sonusH248FeatureLicenseExpiryNotification
sonusH248FeatureLicenseLimitNotification
sonusH248ScDisconnectedTxNotification
sonusH248ScFailoverTxNotification
sonusH248ScFailoverTxStatusNotification
sonusH248ScHandoffRxNotification
sonusH248ScHandoffTxNotification
sonusH248ScHandoffTxStatusNotification
sonusH248ScRestartRxNotification
sonusH248ScVerNegotiatedNotification
sonusH248ScVerNotSupportedNotification
sonusH248SigPortCloseNotification
sonusH248SigPortOpenNotification
sonusPipeTMControlModifiedNotification
sonusPipeTMControlProvisionedNotification
sonusPipeTMControlRemovedNotification
sonusPolicyServerCongestionNotification
sonusPolicyServerNoRouteFoundNotification
sonusPolicyServerPipeIOErrorNotification
sonusPolicyServerPipeMWIQueueLevelChanged
sonusPolicyServerRegisterNotification
sonusPolicyServerScpTimeoutNotification
sonusPolicyServerUnregisterNotification
sonusSbxArsEndPointRecoveredNotification
sonusSbxArsEndPointsRecoveredNotification
sonusSbxCallProcAnswerSupervisionTimeout
5–37
Traps
Parameter
Field
Length
Description
trap
(continued)
NA
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
state
N/A
Specifies the administrative state of this trap:
sonusSbxCallProcLongDurationCallTimeout
sonusSbxGwSigChanCloseNotification
sonusSbxGwSigChanOpenAttemptNotification
sonusSbxGwSigChanOpenNotification
sonusSbxGwTrunkGroupInServiceNotification
sonusSbxNodePolicerClearAlarmNotification
sonusSbxNodePolicerMajorAlarmNotification
sonusSbxNodePolicerMinorAlarmNotification
sonusSbxNrsIpInterfaceAdminISNotification
sonusSbxNrsIpInterfaceISNotification
sonusSbxNrsIpInterfaceOOSNotification
sonusSbxNrsMgmtPortDownNotification
sonusSbxNrsMgmtPortUpNotification
sonusSbxNrsPacketPortDownNotification
sonusSbxNrsPacketPortUpNotification
sonusSbxSelCdrConfUpdateNotification
sonusSbxSipCallSigPortCloseNotification
sonusSbxSipCallSigPortOpenNotification
sonusSbxSipTgRegLimitReachedNotification
sonusSbxSscsRejectIndNotification
sonusSbxSscsRouteFailureNotification
sonusSbxSscsTransErrorNotification
sonusSbxTrunkGroupAutomaticControlActive
sonusSbxTrunkGroupManualControlActive
• disabled (default) - Off. In this state the trap message is not
sent to a management client.
• enabled - On. In this state the trap message will be sent to all
properly registered and authenticated management clients.
displayleve
l
1-64
commands.
Command Example
To display the trap information:
% show oam traps admin
sonusConnexIpSystemCEFanFailureNotification
sonusConnexIpSystemCEFanFailureNotification{
enabled
}
5–38
CHAPTER 6
Profiles
Overview
A profile allows you to create a specific set of characteristics different from the
standard SBC 5x00 defaults. When you define a new instance, then you can use
the profile to set the values as you would like them.
Profiles are referenced by other configuration objects through the system are a
means of sharing the same configuration values among multiple object instances.
Supported Profiles
The following profiles are supported:
•
•
•
•
•
•
•
•
•
•
•
"Call Parameter Filter Profile" on page 6–2
"Call Routing" on page 6–5
"Digit Parameter Handling" on page 6–17
"Digit Profile" on page 6–57
"DTMF Trigger" on page 6–64
"Media" on page 6–66
"Security" on page 6–96
"Services" on page 6–105
"Signaling" on page 6–115
"SIP CAC Profile" on page 6–189
"System Profile" on page 6–192
6–1
Profiles
Call Parameter Filter Profile
This object defines Call Parameter Filter Profile (CPFP) entries. The SBC 5x00
uses the call parameters defined in these entries in addition to the call parameters
on the Standard Route, Private Call Routing and User name Routing screens
when selecting a routing label.
This profile can also be used in addition to the call parameters of the Class of
Service associated with Destination Forced Routes and Services Standard
Routes. CPFPs can be grouped on Call Parameter Filter Group Profiles, to
increase the range of the call parameters that the SBC 5x00 will process.
Command Syntax
% set profiles callParameterFilterProfile
<callParameterFilterProfile> description <description>
% show profiles
callParameterFilterProfile <callParameterFilterProfile>
SIP_MSG_TYPE_INFO <SIP_MSG_TYPE_INFO>
SIP_MSG_TYPE_NOTIFY <SIP_MSG_TYPE_NOTIFY>
SIP_MSG_TYPE_REGISTER <SIP_MSG_TYPE_REGISTER>
SIP_MSG_TYPE_SUBSCRIBE <SIP_MSG_TYPE_SUBSCRIBE>
none <none>
% delete callParameterFilterProfile
<callParameterFilterProfile>
6–2
Profiles
Command Parameters
TABLE 6–1
Call Parameter Filter Profile parameters
Parameter
Field
Length
callParamete N/A
rFilterProfi
le
Description
Specifies the name of the Call parameter filter profile. The
possible values are:
• SIP_MSG_TYPE_INFO - The SIP message type is INFO.
• SIP_MSG_TYPE_NOTIFY - The SIP message type is NOTIFY.
• SIP_MSG_TYPE_REGISTER - The SIP message type is
REGISTER.
• SIP_MSG_TYPE_SUBSCRIBE - The SIP message type is
SUBSCRIBE.
• none - The SIP message type is none.
description
N/A
Specifies the description of the call parameter filter profile.
Enter the description for the call parameter filter profile.
Must be between 1-199 characters.
displaylevel
1-64
commands.
Command Example
% show callParameterFilterProfile
<callParameterFilterProfile>
callParameterFilterProfile SIP_MSG_TYPE_INFO {
description Test_new;
}
callParameterFilterProfile SIP_MSG_TYPE_NOTIFY {
description Test_TP;
}
callParameterFilterProfile SIP_MSG_TYPE_REGISTER {
description Test_TP11;
}
callParameterFilterProfile SIP_MSG_TYPE_SUBSCRIBE {
description Test_tp129;
}
callParameterFilterProfile none {
description "seed data for provisioning support ";
}
6–3
Profiles
To display call parameter filter profile details with display level set to 1:
% show profiles callParameterFilterProfile displaylevel 1
callParameterFilterProfile SIP_MSG_TYPE_INFO;
callParameterFilterProfile SIP_MSG_TYPE_NOTIFY;
callParameterFilterProfile SIP_MSG_TYPE_REGISTER;
callParameterFilterProfile SIP_MSG_TYPE_SUBSCRIBE;
callParameterFilterProfile none;
To display call parameter filter profile details with display level set to 3:
%
show profiles callParameterFilterProfile displaylevel 3
callParameterFilterProfile SIP_MSG_TYPE_INFO {
description "SIP Message Type is Info";
}
callParameterFilterProfile SIP_MSG_TYPE_NOTIFY {
description "SIP Message Type is Notify";
}
callParameterFilterProfile SIP_MSG_TYPE_REGISTER {
description "SIP Message Type is Register";
}
callParameterFilterProfile SIP_MSG_TYPE_SUBSCRIBE {
description "SIP Message Type is Subscribe";
}
callParameterFilterProfile none {
description test;
}
6–4
Call Routing
Profiles
Call Routing
SBC 5x00 supports the following type of Call Routing profiles:
•
•
•
•
"Crankback Profile" on page 6–5
"Element Routing Priority Profile" on page 6–8
"Holiday" on page 6–9
"Time Range Profile" on page 6–11
Crankback Profile
This object creates a Crankback Profile. This profile is a table of call release
codes that cause the SBC 5x00 to attempt to reroute (or "crankback") the call
when a matching code is returned by Egress Signaling.
The Crankback Profile contains the call release codes that automatically cause
the SBC 5x00 software to reroute the call. Additional release codes may be added
to the table. Any release code that is in the table, including any default code, may
be removed from the table. Removing a release code from the table causes the
SBC 5x00 software to return that release code to Ingress Signaling rather than
attempting to reroute the call.
Up to 20 Crankback Profiles may be created, including default. As profiles are
created, they are assigned the indexes 2, 3, 4, and so on, by the SBC 5x00
software. (Index 1 is assigned to default.) The assigned index may be displayed
by the show commands. By using the appropriate index, a particular Crankback
Profile may be assigned to a particular SIP, or H.323 trunk group for ingress
signaling.
This object influences rerouting policy for SIP 3xx Redirection processing if you
configure the IP Profile on the SBC 5x00 to use the Crankback Profile. Then,
when a SIP 3xx Redirect is initiated and a SIP INVITE message is issued, if a
disconnect release code is returned in the SIP response, the Crankback Profile is
searched for a matching code. If a matching code is found and at least one more
SIP redirect destination is present; a SIP INVITE is issued to that destination.
This scenario is repeated up to ten times, after which additional SIP redirect
destinations are disregarded as if not present. (However, only four Contact
headers in a redirect are accepted and processed. If more than four Contact
headers are sent, they are currently ignored.)
If a matching code is found but no additional SIP redirect destination is present,
the SIP redirect is terminated with that code. If no matching code is found in the
Crankback Profile, then the SIP redirect is terminated with that (unmatched) code.
6–5
Profiles
Call Routing
Command Syntax
% set profiles callRouting crankbackProfile
<crankbackProfile>
attemptRecordGeneration <attemptRecordGeneration>
lateCrankback <lateCrankback>
reason <reason>
% show profiles callRouting crankbackProfile
<crankbackProfile>
default
attemptRecordGeneration <attemptRecordGeneration>
lateCrankback <lateCrankback>
reason <reason>
% delete profiles callRouting crankbackProfile
<crankbackProfile>
Command Parameters
TABLE 6–2
Parameter
Crankback Profile Parameters
Field
Length
Description
crankbackPro 1-23
file
Specifies the name of the Call Crankback Profile, or the
table of call reason codes that cause crankback by the SBC
5x00 software. Must be 1-23 characters.
attemptRecor N/A
dGeneration
Specifies whether the SBC 5x00 should generate an
attempt accounting record whenever a call is rerouted
(cranked back):
• enabled - generates an attempt record when a call is
rerouted by the SBC 5x00.
• disabled (default) - does not generate an attempt record
when a call is rerouted by the SBC 5x00.
lateCrankbac N/A
k
Specifies whether to allow crankback after an ALERTING,
PROCEEDING, or equivalent message (backwards call
message) has been received from the egress network:
• enabled - allows crankback after a backward call message is
received from the egress network.
• disabled (default) - do not allow any crankback after a
backward call message is received from the egress network.
6–6
Call Routing
TABLE 6–2
Profiles
Crankback Profile Parameters (Continued)
Parameter
Field
Length
reason
1-255
Description
Specifies the range of call termination reason codes that,
when returned by Egress Signaling, cause the SBC 5x00
software to attempt to reroute the call. Must be 1-255.
Options are:
• location - Use Location table values for this reason code
while cranking back on the next route. Options are:
- internationalNet
- natReserved6
- natReserved12
- netBeyondInterPoint
- privateLocal
- privateRemote
- publicLocal
- publicRemote
- transitNet
- vuser
• useLocationValue - Use Location table values for this
reason code while cranking back on the next route. Options
are:
- disabled
- enabled - Options are:
- internationalNet
- natReserved6
- natReserved12
- netBeyondInterPoint
- privateLocal
- privateRemote
- publicLocal
- publicRemote
- transitNet
- vuser
displaylevel
1-64
commands.
Command Example
% show profiles callRouting crankbackProfile
crankbackProfile default {
reason 2;
reason 3;
}
6–7
Profiles
Call Routing
Element Routing Priority Profile
Element Routing Priority profile entries are similar to the routing criteria, in that
they also select elements that must be factored into the routing lookup. The
Element Routing Profile indicates what originating Call Processing Elements
types (including "none") must be used to determine matching routing table entries.
In contrast to the Routing Criteria entities, routing table lookups are attempted in
priority order for all matching Call Processing Element types until a match is
found.
Different Element Routing Priority tables can be associated with different (ingress)
trunk groups or countries. If no Element Routing Priority table is explicitly
associated with a trunk group, the Element Routing Priority table associated with
the trunk group's country (or the default assigned to the country) is used.
Command Syntax
% set profiles callRouting elementRoutingPriority
<elementRoutingPriority>
entry <entry>
entityPriority <entityPriority>
entityType <entityType>
% show profiles callRouting elementRoutingPriority
entry <entry>
% delete profiles callRouting elementRoutingPriority
Command Parameters
TABLE 6–3
Parameter
Element Routing Priority parameters
Field
Length
elementRouti 1-23
ngPriority
6–8
Description
Specifies the name of the Routing Criteria Profile. Must be
1-23 characters.
Call Routing
Profiles
Parameter
Field
Length
Description
entry
N/A
Specifies the routing entry. The possible values are:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
entityPriori N/A
ty
entityType
N/A
Specifies the entity priority.
Specifies the entity type. The possible values are:
•
•
•
•
displaylevel
1-64
private
carrierCutThrough
internationalType
ipVpnService
localOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
test
transit
userName
callingNumber
carrier
none
trunkGroup
commands.
Command Example
% show profiles callRouting elementRoutingPriority Test_TPS
entry nationalType 345
{
entityType businessGroup;
}
Holiday
This object is used to provision days of the year that are national holidays. This
allows you to apply number translations or specific treatment on holidays.
6–9
Profiles
Call Routing
Command Syntax
// Mandatory parameters that are required to configure a Call routing profile:
% set profiles callRouting holiday <holiday> <month>
<dayOfMonth>
// Non-mandatory parameters that can be used to configure a Call routing profile:
% set profiles callRouting description <description>
% show set profiles callRouting <holiday>
% delete set profiles callRouting <holiday>
Command Parameters
TABLE 6–4
Holiday parameters
Parameter
Field
Length
holiday
N/A
Description
Indicates the number of the holidays. The possible values
are:
1
40
223
233
243
253
264
299
359
379
6–10
20
41
224
234
244
254
265
350
370
380
27
43
225
235
245
255
266
351
371
381
30
212
226
236
246
256
267
352
372
385
31
213
227
237
247
257
268
353
373
386
32
216
228
238
248
258
269
354
374
387
33
218
229
239
249
260
290
355
375
389
34
36
220 221
230 231
240 241
250 251
261 262
291 297
356 357
376 377
420 421
39
222
232
242
252
263
298
358
378
423
Call Routing
Parameter
Field
Length
month
N/A
Profiles
Description
Specifies the name of the month. The month can take the
following values:
•
•
•
•
•
•
•
•
•
•
•
•
january
february
march
april
may
june
july
august
september
october
november
december
dayOfMonth
N/A
Specifies the day of the month.
description
N/A
Specify the description for the holiday.
displaylevel
1-64
commands.
Command Example
% show profiles callRouting holiday
holiday 1 april 23
{
description Good_friday;
}
Time Range Profile
This object is used to specify day-and time-based matching for SBC 5x00
provisioning entities such as Standard Route, Private Call Routing, and Number
Translation. You can create multiple day/time entries per profile.
Command Syntax
// Mandatory parameter for Time range profile
% set profiles callRouting timeRangeProfile
<timeRangeProfile> entry <entry> timeZone <timeZone>
6–11
Profiles
Call Routing
// Non-mandatory parameter for Time range profile
<timeRangeProfile> entry <entry> dayMatching
<dayMatching>
dayOfWeek <dayOfWeek>
holidays <holidays>
specialDays <specialDays> range
<timeRangeProfile> entry <entry> timeMatching
<timeMatching> range <range>
% show profiles callRouting timeRangeProfile
<timeRangeProfile>
entry <entry>
% delete profiles callRouting timeRangeProfile
<timeRangeProfile>
Command Parameters
TABLE 6–5
Parameter
Time Range Profile parameters
Field
Length
Description
timeRangePro N/A
file
entry
6–12
N/A
Specifies a unique identifier for the Time Range profile.
Specifies an unsigned integer for the Time Range profile.
Call Routing
Profiles
Parameter
Field
Length
Description
timeZone
N/A
Specifies the time zone.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
australiaAct
australiaBrokenHill
australiaLhi
australiaNorth
australiaNsw
australiaQueensland
australiaSouth
australiaTasmania
australiaVictoria
australiaWest
australiaYancowinna
brazilAcre
brazilDeNoronha
brazilEast
brazilWest
canadaAtlantic
canadaCentral
canadaEast Saskatchewan
canadaEastern
canadaMountain
canadaNewfoundland
canadaPacific
canadaYukon
chileContinental
chileEasterIsland
china
egypt
europeCentral
europeEastern
europeWestern
gmt, gmt+1, gmt+10, gmt+11, gmt+12, gmt+13
gmt+2, gmt+3, gmt+4, gmt+5, gmt+6, gmt+7,
gmt+8, gmt+9, gmt-1, gmt-10, gmt-11, gmt-12,
gmt-2, gmt-3, gmt-4, gmt-5, gmt-6, gmt-7, gmt8, gmt-9
• greatBritain
• greenwich
• hongKong
6–13
Profiles
Parameter
timeZone
(continued)
Call Routing
Field
Length
N/A
Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
hstHonolulu
iceland
iran
ireland
israel
jamaica
japan
korea
kwajalein
libya
mexicoBajaNorte
mexicoBajaSur
mexicoGeneral
moscow
navajo
newZealand
newZealandChatham
poland
portugal
psxLocal
singapore
taiwan
turkey
uct
unitedStatesAlaska
unitedStatesAleutian
unitedStatesArizona
unitedStatesCentral
unitedStatesEastIndiana
unitedStatesEastern
unitedStatesHawaii
unitedStatesMichigan
unitedStatesMountain
unitedStatesPacific
unitedStatesPacificNew
unitedStatesSamoa
zulu
6–14
Call Routing
Parameter
Field
Length
dayMatching
N/A
Profiles
Description
Specifies the matching day for the Time Range profile. The
• dayOfWeek - Specifies the day of week. The possible values
are:
friday
monday
saturday
sunday
thursday
tuesday
wednesday
• holidays - Represents a holiday. Options are:
disable
enable
• specialDays - Specifies special days. The possible values
are:
all
days
none
timeMatching N/A
Specifies the time of day to which the associated entity
applies. Options are:
• all
• minutes - Specify minutes.
• none
displaylevel
1-64
commands.
Command Example
% show profiles callRouting timeRangeProfile
entry 1 {
timeZone navajo;
dayMatching {
dayOfWeek
monday,tuesday,wednesday,thursday,friday,saturday,sunday;
holidays
enable;
specialDays {
range days;
6–15
Profiles
Call Routing
}
}
timeMatching {
range minutes;
}
}
6–16
Digit Parameter Handling
Profiles
This object allows you to configure criteria for applying DM/PM (digit manipulation/
parameter manipulation) rules. You can also use this entity to define criteria for
applying URI manipulation rules.
For digit manipulation, the matching criteria can be digits in the calling or called
numbers, out pulse numbers from SCP queries, generic numbers, and so on. For
example, you can provision the Policy Server to check if the first three digits of the
calling number are 617, or to check if digits 4 through 6 are 723.
For parameter manipulation, the matching criteria is based on the specified
parameter type. For example, you can provision the Policy Server to match a
specified Calling Party Category (CPC), or match a specified Originating Line
Information Parameter (OLIP) value.
There is also a URI parameter type used to match the contents of the specified
URI type.
Command Syntax
dmPmCriteria <dmPmCriteria>
dmPmRule <dmPmRule>
numberTranslationCriteria <numberTranslationCriteria>
numberingPlan <numberingPlan>
prefixProfile <prefixProfile>
% set profiles digitParameterHandling dmPmCriteria
<TO_HEADER_EXISTS>
criteriaType <criteriaType>
parameterPresenceCheck <parameterPresenceCheck>
uriCriteria <uriCriteria>
uriType <uriType>
<PAI_TEL_DISPLAY_NAME>
parameterPresenceCheck <parameterPresenceCheck>
parameterCriteria <parameterCriteria>
parameterType <parameterType>
6–17
Profiles
<dmPmCriteria>
parameterPresenceCheck <parameterPresenceCheck
digitCriteria <digitCriteria>
digitType <digitType>
% set profiles digitParameterHandling dmPmRule <dmPmRule>
subRule <subRule>
criteria <criteria>
parameterManipulation <parameterManipulation
ruleType <ruleType>
subRule <subRule>
criteria <criteria>
uriManipulation <uriManipulation
ruleType <ruleType>
subRule <subRule>
criteria <criteria>
digitManipulation <digitManipulation
ruleType <ruleType>
<elementID1> <elementID2> <national> <country>
<lookupType>
set profiles digitParameterHandling prefixProfile
<prefixProfile>
% show profiles digitParameterHandling <digitParameterHandling>
% show profiles digitParameterHandling <digitParameterHandling>
dmPmCriteria <dmPmCriteria>
dmPmRule <dmPmRule>
numberingPlan <numberingPlan>
prefixProfile <prefixProfile>
6–18
Profiles
% delete profiles digitParameterHandling
<digitParameterHandling>
6–19
Profiles
Command Parameters
6–20
Profiles
TABLE 6–6
CMDS Parameters
Parameter
Field
Length
dmPmCriteria 1-23
Description
Specifies the name of a DM/PM criteria, which can be
assigned to one or more DM/PM rules. The options are:
• criteriaType - Select Digit Manipulation, Parameter
Manipulation, or URI manipulation to set criteria for performing
digit, parameter, or URI manipulation. The criteria type options
are:
digit - Specify criteria for digit matching. Options are:
- digitCriteria - Specify the criteria for applying
DM/PM rules. Options are:
- digitMatch - Options are:
- operation - Options are:
equals - The criterion applies if the designated
value matches the actual value exactly.
ignore - Do not apply the criterion in this
section.
notEquals - The criterion applies if the
designated value does not match the actual
value.
- value - The value to use for matching. Options
are:
- matchValue - Specifies the value to use for
matching. The number of digits in the match value
must be the same as the number specified in the
Number of Digits field.
- numberOfDigits - Specifies the total number
of digits to use for comparison. For example, if the
start digit position is 0 and the number of digits
specified is 3, reading from left to right, the PSX
would use the first, second, and third digits of the
complete number for the comparison. Must be 02147483647. Default value is 0.
- startDigitPosition - The first position
within the complete number specified in the Digit
Type field to start the comparison with the value
specified in the Match Value field. The start digit
position 0 is the left-most digit of the complete
number. Must be 0-2147483647. Default value is
0.
- egressFlag
equals - Set the egress flag to a particular
value.
section.
notEquals
- The
criterion
the permission.
© 2012 Sonus Networks, Inc. Confidential and Proprietary.
All Rights
Reserved.
Do notapplies
distributeifwithout
value.
6–21
Profiles
TABLE 6–6
Parameter
6–22
CMDS Parameters (Continued)
Field
Length
Description
TABLE 6–6
Parameter
Profiles
Field
Length
dmPmCriteria 1-23
(continued)
Description
- value - Specifies the value to use for matching.
The PSX applies DM rules based on whether the
egress flag for the associated digit type has been
set to either send or dontSend. Options are:
- dontSend
- send
- natureOfAddress - Specifies the nature of
address to be used as a matching criterion.
section.
value.
- value - Specifies the value used for matching.
Options are:
950
aniOfCalledPartyNationalNumber
aniOfCalledPartySubscriberNumber
aniOfCallingPartySubscriberNumber
apnNumberingPlan
international
aniNotAvailableOrNotProvided
aniOfCalledPartyNoNumberPresent
aniOfCallingPartyNationalNumber
any
ignore
internationalNotRestricted
internationalRestricted
national
nationalOperator
networkSpecific
noNumberOperatorRequested
partialCallingLineId
sidNumber
nationalNotRestricted
nationalRestricted
noNumberCutThrough
none
passThrough
spare0A
spare0B
spare0C
spare0D
spare0E
spare0F
spare01
spare1A
spare1B
spare1C
spare1D
spare1E
spare1F
spare02
spare2A
spare2B
6–23
Profiles
TABLE 6–6
Parameter
Field
Length
dmPmCriteria 1-23
(continued)
Description
spare3D
spare04
spare4A
spare4D
spare4E
spare5A
spare5B
spare5E
spare5F
spare6B
spare6C
spare6F
spare07
spare7C
spare7D
spare08
spare09
spare12
spare13
spare16
spare17
spare20
spare21
spare24
spare25
spare3E
spare3F
spare4B
spare4C
spare4F
spare05
spare5C
spare5D
spare06
spare6A
spare6D
spare6E
spare7A
spare7B
spare7E
spare7F
spare10
spare11
spare14
spare15
spare18
spare19
spare22
spare23
spare26
- numberLength - Specifies the length of the phone
number.
value.
section.
lessThanOrEquals - The criterion applies if
the designated length is less than or equal to the
actual length.
greaterThanOrEquals - The criterion applies
if the designated length is greater than or equal to
the actual length.
Must be 0-32. Default value is 0.
numberingPlanIndicator - The numbering plan
indicator is used as a matching criterion.
6–24
value matches
actual
exactly.
All Rights the
Reserved.
Do value
not distribute
without permission.
section.
TABLE 6–6
Parameter
Profiles
Field
Length
Description
dmPmCriteria 1-23
(continued)
section.
value.
Options are: allowed none
numberUnavailable restricted spare
- screeningMatch - Specifies the calling party
number screening type to be used as a matching
criterion. Options are:
section.
value.
- value - Specifies the value uses for matching.
Options are: networkProvidedNotScreened
none
userProvidedFailedNetworkScreening
userProvidedNotScreened
userProvidedPassedNetworkScreening
- digitType - Specifies the digit/parameter type to which
this DM/PM Criteria entry applies. Options are:
252
253
254
billingNumber
calledDirectoryNumber
calledInNumber
calledNumber
callingNumber
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnAdditionalConnected
gnAdditionalOriginalCalled
gnAdditionalRedirecting
gnAdditionalRedirection gnCalledCesId
gnCollectCallNumber
gnDestination
gnDialedDigits gnLocalAni
gnNetworkProvidedNumber gnPortedDialed
gnRedirectingTerminating
gnThirdPartyNumber
gnUserCallingNotScreened
© 2012 Sonus Networks, Inc. Confidential
and Proprietary. All Rights Reserved. Do not distribute without permission.
gnUserCallingScreened
location
originalCalledNumber outpulseNumber
6–25
Profiles
TABLE 6–6
Parameter
Field
Length
dmPmCriteria 1-23
(continued)
Description
- parameterPresenceCheck - The PSX applies PM
rules based on whether a parameter exists or does not
exist. Options are:
- doesntExist - The PSX applies the associated PM
rule if the parameter is not present in the call
parameters.
- exists - The PSX applies the associated PM rule if
the parameter is present in the call parameters.
- parameter
- parameterCriteria - The parameter type to
apply the parameter manipulation to. Options are:
- information - The additional category
information to use as a matching criterion.
section.
value.
Options are: any auto inflight
maritime pager
- name - Specifies the additional category name
to use as a matching criterion.
equals - The criterion applies if the
designated value matches the actual value
exactly.
section.
value.
- value - Specifies the value used for
matching. Options are: mobile1 mobile2
pstn1
exist. Options are:
6–26
550-05337in
—the
Version
rule if the parameter is not present
call0.3 — Release V03.00.00
parameters.
TABLE 6–6
Parameter
Profiles
Field
Length
Description
dmPmCriteria 1-23
(continued)
additionalCategory
carrierCode
cpc
jurisdictionSwitch
paiSipDisplayName
calledPrefix
carrierSelectionParameter
dpcIndicator
olip
paiTelDisplayName
callingName
causeOfNoId
forwardCallIndicator
originatingCarrier
transitNetworkSelection
callingPrefix
cliBlockingIndicator
fromDisplayName
originatingChargeArea
zzCode
- uri
exist. Options are:
rule if the parameter is not present in the call
parameters.
- uriCriteria - Options are:
- host - Specify the host name.
section.
value.
- presentationMatch - Specifies the
presentation type to be used as a matching
criterion. Options are:
section.
6–27
Profiles
TABLE 6–6
Parameter
Field
Length
dmPmCriteria 1-23
(continued)
Description
value.
Options are: allowed none
numberUnavailable restricted spare
- userInfo - Specify the user information.
section.
value.
- value - Specifies the value uses for matching.
- matchValue - Enter a string.
- startCharacterPosition - The start
position of the character string to use as a
matching criterion, which can be digits or
calling name. Must be 0-2147483647. Default
value 0.
- validateUserInfoDigits - Validate user info
digits based on specified operation.
section.
value.
Options are: host presentationMatch
userInfo
- uriType - Specify the type of URI. Options are:
calledUri callingUri fromUri paiSipUri
toUri
6–28
TABLE 6–6
Profiles
Parameter
Field
Length
dmPmRule
N/A
Description
Specifies the name of this DM/PM (digit manipulation/
parameter manipulation) rule, up to 23 characters.
NOTE
The DM/PM rules mentioned
below are default rules, but you
can also create your own DM/PM
rules.
Following are default DM/PM rules:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
PAI_AND_FROM_HEADER
PAI_DISPLAY_NAMES_1_NTL
PAI_SIP_DSPNAME_CLG_NAM
PAI_TEL_DSPNAME_GN_CPN
PRFX_TO_HEADER_CDPN_NTL
PRFX_TO_HEADER_GDPN_NTL
PRFX_TO_HEADER_OCN_NTL
SIP_ADD_PLUS
SIP_REMOVE_CLG81
SIP_REMOVE_PLUS1
SIP_REMOVE_PLUS39
SIP_REMOVE_PLUS44
SIP_REMOVE_PLUS49
SIP_REMOVE_PLUS52
SIP_REMOVE_PLUS81
SIP_REMOVE_PLUS86
SIP_REMOVE_PLUS91
subRule
N/A
Specify the sequential order for applying DM/PM subrules
criteria
N/A
Specifies the DM/PM criteria.
6–29
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
Description
This parameter is applicable only when you select the
following DM/PM Rules:
• PAI_DISPLAY_NAMES_1_NTL
• PAI_SIP_DSPNAME_CLG_NAM
• PAI_TEL_DSPNAME_GN_CPN
The following are the list of parameter values and their
description:
• availability - The availability attribute of the specified
parameter to use in the PM rule. When none is selected, the
attribute is not used. Options are: no none yes
• characterManipulation - Options are:
- numberOfCharacters - The total number of
characters to use for the rule. For example, if the start
position is 0 and the number of characters specified is
3, reading from left to right, the PSX would use the first,
second, and third characters of the complete string for
the rule. Must be 0-64. Default value is 24.
- replacement
- characterString - For variable replacement,
the type of character from which to extract the
replacement characters. Options are:
252
billingNumber
calledNumber
callingNumber
contractorNumber
gnAdditionalCalled
gnCalledCesId
gnDialedDigits
gnPortedDialed
none
paiSipDisplayName
presentationNumber
redirection
twoStageCollected
253
calledUri
callingUri
dialedNumber
gnAdditionalCalling
gnCollectCallNumber
gnLocalAni
6–30
TABLE 6–6
Parameter
Profiles
Field
Length
Description
parameterMan N/A
ipulation
(continued)
originalCalledNumber
paiSipUri
pretranslated
sipFromDisplayName
254
calledInNumber
callingName
causeOfNoId
fromUri
gnAdditionalRedirection
gnDestination
gnNetworkProvidedNumber
gnThirdPartyNumber
location
outpulseNumber
paiTelDisplayName
redirecting
toUri
position is 0 and the number of characters specified
is 3, reading from left to right, the PSX would use the
first, second, and third characters of the complete
string for the rule. Must be 0-999. Default value is 0.
- replacementType - Options are:
- constant- Enter a constant.
- value - Enter a string.
- variable - Enter a variable.
- startCharacterPosition - The start position of
the characters to use for the rule. The start position 0 is
the left-most character of the complete string. Must be
0-30. Default value is 0.
• parameterType -
- additionalCategory - The additional CPC
information to use as a matching criterion. Options are:
- informationMobile1 - Options are: any auto
inflight maritime pager
- userName - The additional calling party category
(CPC) name to use in the PM rule.
- mobile1
- mobile2
- informationMobile2 - Options are: analog
any cdma800Mhz iridium njtacs
nstar pdc800Mhz pdc1500Mhz
6–31
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
(continued)
Description
- pstn1
- informationPstn1 - Options are: any
pinkPublicPhone trainPublicPhone
- causeOfNoId - The cause of no ID parameter to use
in the PM rule.
- includeInEgressFlag - Specifies whether the
cause of No ID is included in the egress trunk group,
or discarded. Options are: discardInEgress
includeInEgress none
- matchNumber - The Cause Of No ID parameter is
used as a matching criterion. Options are:
coinPhone interactionWithOtherService
invalid reserved userRequested
- dpcIndicator - Specifies the destination point code
(DPC) indicator to use as a matching criterion.
- originatingCarrier - Specifies the originating
carrier ID to use as a matching criterion. Options are:
- originatingCarrier - Specifies the originating
carrier ID to use as a matching criterion. Enter a
string.
- poiChargeArea - Specifies the Point of Interface
(POI) charge area to use as a matching criterion. The
POI charge area represents the point of demarcation
between two carriers. Enter a string.
- poiLevel - Specifies the POI level to use as a
matching criterion. Options are:
0 - The trunk group does not have multiple POI
levels.
1 - PSX fixed services (for carriers with more
than one POI level).
2 - Mobile services (for carriers with more than
one POI level).
- sipFromDisplayName - Options are:
- characterManipulation - Options are:
characters to use for the rule. For example, if the
start position is 0 and the number of characters
would use the first, second, and third characters of
the complete string for the rule. Must be 0-64.
- replacement - Options are:
6–32
- replacementType - Options are:
- constant - Enter a constant.
TABLE 6–6
Parameter
Profiles
Field
Length
parameterMan N/A
ipulation
(continued)
Description
- variable - Enter a variable.
- variableString - Enter a string.
- startCharacterPosition - The start position
of the characters to use for the rule. The start
position 0 is the left-most character of the complete
string. Must be 0-30. Default value is 0.
- fromDisplayName - Options are:
- availability - The availability attribute of the
specified parameter to use as a matching criterion.
Options are: no none yes
- presentation - The calling name presentation
attribute to use in the PM rule. Options are:
allowed none numberUnavailable
restricted spare
- callingName - The calling name presentation
attribute to use in the PM rule. Options are:
- availability - The availability attribute of the
specified parameter to use as a matching criterion.
Options are: no yes none
- callingNameGeneric - The generic string
attribute of the calling name parameter to use as a
matching criterion. Enter a string.
attribute to use as a matching criterion. Options are:
allowed blockingToggle noIndication
none restricted
- typeOfName - The type of name attribute of the
calling name parameter to use as a matching
criterion. Options are: calling connected
none originalCalled redirecting
spare
- chargeRateInfoIndicator - Options are:
- flags - Select
discardChargeParametersFromBackwardMess
ages flag. Options are:
disable - The charge parameters are included
in backward messages (default).
enable - The charge parameters are discarded
from messages being sent back to the ingress
trunk group.
- forwardCallIndicator - This parameter is
indicates whether a call needs to be routed over SS7
supported facilities. Options are:
6–33
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
(continued)
Description
- international - The International attribute of the
forward call indicator to use as a matching criterion.
- interworking - The Interworking attribute of the
forward call indicator to use as a matching criterion.
- isdnIndicator - The ISDN Indicator attribute of
the forward call indicator to use as a matching
criterion. Options are: no none yes
- isupBiccIndicator - The ISUP/BICC Indicator
attribute of the forward call indicator to use as a
matching criterion. Options are: no none yes
- isupBiccPreference - The ISUP/BICC
preference of the forward call indicator to use as a
matching criterion. Options are: none
notRequired preferred required
- originatingChargeArea - The originating charge
area to use in the PM rule. Enter a string.
- transitNetworkSelection - Options are:
- carrierCodeDigitMatch
- carrierCode - The carrier code of the transit
network selection to use as a matching criterion.
Enter a string.
- numberOfDigits - The number of carrier code
digits to use as a matching criterion. Must be 0-999.
Default value is 0.
- startDigitPosition - The first position within the
complete number specified in the Digit Type field to
start the comparison with the value specified in the
Match Value field. The start digit position 0 is the leftmost digit of the complete number. Must be 0-30.
Default value is 0.
network selection to use as a matching criterion. Enter
a string.
- carrierCodeDigitMatch - Options are:
network selection to use as a matching criterion.
Enter a string.
- numberOfDigits - The number of carrier code
digits to use as a matching criterion. Must be 0-999.
Default value is 0.
6–34
- startDigitPosition - The start position of the
carrier code digits (specified in the Carrier Code
field above) to use as a matching criterion. Must be
0-30.
Default
is 0. Do not distribute without permission.
© 2012 Sonus Networks, Inc. Confidential and
Proprietary.
All value
Rights Reserved.
TABLE 6–6
Parameter
Profiles
Field
Length
parameterMan N/A
ipulation
(continued)
Description
- networkIdPlan - The network ID plan of the
transit network selection to use as a matching
criterion.
- ccittLandMobile
- ccittUnknown
- nationalReserved2
- ccittPublicData
- nationa4DigitCarrier
- nationalUnknown
- ccittReserved1
- national3DigitCarrier
- none
- ccittReserved2
- nationalReserved1
- networkIdType - The network ID type of the
transit network selection to use as a matching
criterion. Options are: ccitt national none
other
- cliBlockingIndicator - The CLI Blocking
Indicator parameter is used as a matching criterion.
- jurisdiction - The switch ID of the jurisdiction
parameter to use in the PM rule. Options are:
characterString - For variable replacement,
252
billingNumber
calledNumber
callingNumber
contractorNumber
gnAdditionalCalled
gnCalledCesId
gnDialedDigits
gnPortedDialed
6–35
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
(continued)
Description
none
paiSipDisplayName
presentationNumber
redirection
twoStageCollected
253
calledUri
callingUri
dialedNumber
gnAdditionalCalling
gnCollectCallNumber
gnLocalAni
paiSipUri
pretranslated
sipFromDisplayName
254
calledInNumber
callingName
causeOfNoId
fromUri
gnDestination
gnThirdPartyNumber
location
outpulseNumber
paiTelDisplayName
redirecting
toUri
string. Must be 0-30, Default value is 0.
restricted spare
- zzCode - The zz code to use in the PM rule. Enter a
string.
- carrierSelectionParameter - The carrier
selection parameter to use in the PM rule. Options
are:
6–36
noIndication
notPresubscriptionInput
© 2012 Sonus Networks, Inc. Confidential andpresubscriptionInput
Proprietary. All Rights Reserved. Do not distribute without permission.
presubscriptionNoIndication
presubscriptionNotInput
TABLE 6–6
Parameter
Profiles
Field
Length
parameterMan N/A
ipulation
(continued)
Description
cpc - The Calling Party Category (CPC) to use in the
PM rule. Options are:
ansiSpare1
autoCallCategory1
autoCallCategory3
basicBusinessGroupSubscriber
ccbSubscriber
cellular
cityWideCentrexSubscriber
dataCall
denmark254
hotelSubscriber
iepsCall
interceptionOperator
messageInMailbox
nationalOperatorWithInterventionCapabil
ity
nationalOperatorWithoutTrunkOffer
networkSpecific1
nonInternationalNationalOperator
operatorAvailable1
operatorAvailable3
operatorFrench
operatorRussian
ordFreeLsLs
ordPeriodicLsLs
ordSubscriberLsLs
pabxWithPrivateMetering
pbx
prepaidPhone
ansiSpare2
autoCallCategory2
autoCallCategory4
cancelMessage
ccittSpare2
cellularRoaming
coinPhone
denmark249
emergency
hotelSubscriberWithPriMetering
immediateChargeRateService
lineTestDesk
mobile
nationalOperatorWithTrunkOffer
nationalPublicTelephone
networkSpecific2
nsepCallGovernmentEmergency
operatorAvailable2
operatorEnglish
operatorGerman
operatorSpanish
ordMeteringLsLs
6–37
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
(continued)
6–38
Description
ordPrinterLsLs
ordinarySubscriber
payphone
phoneBox
priorityEmergency
priorityFreeLsTs
prioritySubscriber
reserved
russiaSubscriberCategory1
semiAutoCallCategory2
singaporePbxWithPriority
spare
specialLine2
subscriberWithHomeMeter
testCall
ukAdminDivOrd
ukAdminDivPayphone
ukAmcOpNnd
ukCentrex
ukIsdnBusiness
ukOrdSubBusiness
ukOssOperator
ukPayphoneRentBusiness
priorityPeriodicLsTs
privateMetering
semiPublicPhone
slowOrdinary
specialLine1
subscriberSpecialCharge
teletasa
transitCallViaVoiceService
ukAdminDivOrdPriority
ukAdminDivPayphonePriority
ukAmcOpNndInd
ukDpnss
ukIsdnResidential
ukOrdSubResidential
ukPayphonePublic
ukPayphoneRentResidential
TABLE 6–6
Parameter
Profiles
Field
Length
parameterMan N/A
ipulation
(continued)
Description
- olip - The Originating Line Information Parameter
(OLIP) to use in the PM rule. Options are:
aiod
cellularType2
inmate
oni
pinkPublicPhone
restricted
test1
aniFailure
coin
interceptBlank
otherPhone
pots
restrictedCoinless
tollfree
cellularRoaming
hotel
interceptRegular
outwats
privatePaystation
specialOperator
trs
cellularType1
identified
interceptTrouble
payphoneTollfree
privateVirtualNetwork
telcoOperator
- paiTelDisplayName - The PAI TEL display name
presentation attribute to use in the PM rule. Options
are:
- characterManipulation - Options are:
characters to use for the rule. For example, if the
start position is 0 and the number of characters
would use the first, second, and third characters of
the complete string for the rule. Must be 0-999.
Default value is 0.
- characterString - For variable replacement,
contractorNumber
gnAdditionalCalled
gnCalledCesId
gnDialedDigits
gnPortedDialed
All Rights Reserved. Do not distribute without permission.
6–39
Profiles
TABLE 6–6
Parameter
Field
Length
parameterMan N/A
ipulation
(continued)
Description
none
paiSipDisplayName
presentationNumber
redirection
twoStageCollected
253
calledUri
callingUri
dialedNumber
gnAdditionalCalling
gnCollectCallNumber
gnLocalAni
paiSipUri
pretranslated
calledInNumber
callingName
causeOfNoId
fromUri
gnDestination
sipFromDisplayName
254
gnThirdPartyNumber
location
outpulseNumber
paiTelDisplayName
redirecting
toUri
string. Must be 0-30. Default value is 0.
- presentation - The calling name
presentation attribute to use as a matching
criterion. Options are: allowed none
numberUnavailable restricted
spare
restricted spare
6–40
TABLE 6–6
Parameter
Profiles
Field
Length
uriParameter N/A
Manipulation
Description
•
•
•
•
PAI_AND_FROM_HEADER
PRFX_TO_HEADER_CDPN_NTL
PRFX_TO_HEADER_GDPN_NTL
PRFX_TO_HEADER_OCN_NTL
description:
• hostPortManipulation - Options are:
numberOfCharacters - The total number of characters
to use for the rule. For example, if the start position is 0
and the number of characters specified is 3, reading from
left to right, the PSX would use the first, second, and third
characters of the complete string for the rule. Must be 064. Default value is 0.
portNumber - The port number to be manipulated. Must
be 0-65535. Default value is 999.
replacement - Options are:
characterString - For variable replacement, the
type of character from which to extract the replacement
characters. Options are: calledUri callingUri
fromUri none paiSipUri toUri
numberOfCharacters - The total number of
startCharacterPosition - The start position of the
characters to use for the rule. The start position 0 is the
left-most character of the complete string. Must be 064. Default value is 0.
type - Options are:
constant - Select this option to use the constant
replacement method for manipulation.
noChange - Select this option to cause no
change to the character string.
variable - Select this option to use the variable
value - For constant replacement, the constant to
be used as the replacement value in the
manipulated string. Enter a string.
6–41
Profiles
TABLE 6–6
Parameter
Field
Length
uriParameter N/A
Manipulation
(continued)
Description
• uriParameterManipulation
presentation - The calling name presentation
restricted spare
scheme - Options are: none
unknown
sip
sips
tel
userParameter - Options are: ip
unknown
none
phone
username - Used to control how the SBC 5x00
interprets the Userinfo component of a URI, as either a
telephone number or a username. This impacts DM/PM
rules applied to the called URI and the calling URI.
Options are: none telephone username
• uriType - The URI type to use for the rule. Options are:
calledUri callingUri fromUri paiSipUri
toUri
• userInfoManipulation - Options are:
numberOfCharacters - The total number of
replacement - Options are:
characterString - For variable replacement, the
type of character from which to extract the replacement
characters. Options are:
6–42
paiSipUri
redirecting
twoStageCollected
254
calledNumber
callingUri
fromUri
gnCollectCallNumber
TABLE 6–6
Parameter
Profiles
Field
Length
Description
uriParameter N/A
Manipulation
(continued)
paiTelDisplayName
redirection
billingNumber
calledUri
causeOfNoId
gnAdditionalCalled
gnDestination
gnPortedDialed
outpulseNumber
presentationNumber
sipFromDisplayName
the characters to use for the rule. The start position 0
is the left-most character of the complete string. Must
- type - Options are:
constant - Select this option to use the
constant replacement method for manipulation.
variable - Select this option to use the
variable replacement method for manipulation.
- value - For constant replacement, the constant
to be used as the replacement value in the
manipulated string.
6–43
Profiles
TABLE 6–6
Parameter
Field
Length
digitManipul N/A
ation
Description
Select this option to use this rule for standard digit
manipulation.
•
•
•
•
•
•
•
•
•
•
SIP_ADD_PLUS
SIP_REMOVE_CLG81
SIP_REMOVE_PLUS1
SIP_REMOVE_PLUS39
SIP_REMOVE_PLUS44
SIP_REMOVE_PLUS49
SIP_REMOVE_PLUS52
SIP_REMOVE_PLUS81
SIP_REMOVE_PLUS86
SIP_REMOVE_PLUS91
description:
digitStringManipulation
- action - Used for international gateway support,
which involves setting the NOA to International and
adding the country code, the action to take when the
matching criteria is met, which can be:
addDestinationCountry
addIngressTrunkGroupCountry
addOriginatingCountry none
- numberOfDigits - For Variable Replacement, the
total number of digits within the selected digit string
that will be picked. For example, if the start digit
position is 1 and the number of digits is 3, the PSX
would use the second, third, and fourth digits as the
replacement value. Must be 0-64. Default value is 1.
- digitString - Options are:
6–44
252
253
254
billingNumber calledDirectoryNumber
calledInNumber
calledNumber
calledUri
callingName
callingNumber
callingUri
causeOfNoId
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnCollectCallNumber
TABLE 6–6
Parameter
Profiles
Field
Length
digitManipul N/A
ation
(continued)
Description
gnDestination
gnDialedDigits
gnLocalAni
gnPortedDialed
gnThirdPartyNumber
location
none
outpulseNumber
paiSipDisplayName
paiSipUri
paiTelDisplayName
presentationNumber
pretranslated
redirecting
redirection
sipFromDisplayName
toUri
twoStageCollected
- numberOfDigits - For Variable Replacement,
the total number of digits within the selected digit
string that will be picked. For example, if the start
digit position is 1 and the number of digits is 3, the
PSX would use the second, third, and fourth digits
as the replacement value. Must be 0-64. Default
value is 1.
- startDigitPosition - For Variable
Replacement, the first position in the selected digit
string from where the digits to be modified will be
picked. Must be 0-30. Default value is 0.
- type - Options are: constant
variable
- value - For constant replacement, the constant to
manipulated number.
- numberParameterManipulation - Options are:
- includeInEgress - Specifies whether the
selected number is included in the egress trunk
group, or discarded. Applies to any number specified
by the Number field. Select Include in Egress or
Discard in Egress from the drop-down list. The
default is None; the selected number is passed
transparently (if present), without change. Options
are: discardInEgress includeInEgress
none
- natureOfAddress - The Nature of Address for the
resulting number when this rule is executed. Options
are:
- numberLength - The total number of digits in the
manipulated number. The PSX will truncate the
550-05337 — Version 0.3 — Release V03.00.00number to the specified length if it is currently greater
than the specified length.
- numberingPlanIndicator - The Numbering
Plan Indicator for the resulting number when this rule
6–45
Profiles
TABLE 6–6
Parameter
Field
Length
digitManipul N/A
ation
(continued)
Description
data
ignore isdn
none
offsetUnused private spare0Unknown
spare1
spare2 spare3 spare4
spare5
spare6
spare7
telephony telex
- presentation - The calling party number
presentation type to be used. Options are:
restricted spare
- screening - Specifies the calling party number
screening type to be used. Options are:
networkProvidedNotScreened
none
- numberType - The type of number with which to
associate this rule. Options are:
billingNumber
calledNumber
callingNumber
contractorNumber
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnDestination
gnDialedDigits
gnNQI=252
gnNQI=253
gnNQI=254
gnPortedDialed
location
outpulseNumber
pretranslated
redirecting
redirection
twoStageCollected
6–46
TABLE 6–6
Profiles
Parameter
Field
Length
ruleType
N/A
Description
Select this option to use this rule for standard digit
manipulation.
digit
• criteria
• digitManipulation
- digitStringManipulation - Options are:
- action - Used for international gateway support,
which involves setting the NOA to International and
adding the country code, the action to take when the
matching criteria is met, which can be:
addDestinationCountry
addIngressTrunkGroupCountry
addOriginatingCountry none
- numberOfDigits - For Variable Replacement, the
total number of digits within the selected digit string that
will be picked. For example, if the start digit position is 1
and the number of digits is 3, the PSX would use the
second, third, and fourth digits as the replacement
value. Must be 0-64. Default value is 1.
- digitString - Options are:
252
253
254
calledInNumber
calledNumber
calledUri
callingName
callingNumber
callingUri
causeOfNoId
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnCollectCallNumber gnDestination
gnDialedDigits
gnLocalAni
gnPortedDialed
gnThirdPartyNumber
location
none
outpulseNumber
paiSipDisplayName
paiSipUri
paiTelDisplayName
presentationNumber
pretranslated
redirecting
6–47
Profiles
TABLE 6–6
Parameter
ruleType
(continued)
Field
Length
N/A
Description
redirection
toUri
sipFromDisplayName
twoStageCollected
- numberOfDigits - For Variable Replacement,
the total number of digits within the selected digit
string that will be picked. For example, if the start
digit position is 1 and the number of digits is 3, the
PSX would use the second, third, and fourth digits
as the replacement value. Must be 0-64. Default
value is 1.
- startDigitPosition - For Variable
Replacement, the first position in the selected digit
string from where the digits to be modified will be
picked. Must be 0-30. Default value is 0.
- type - Options are: constant
variable
manipulated number.
- numberParameterManipulation - Options are:
- includeInEgress - Specifies whether the
selected number is included in the egress trunk
group, or discarded. Applies to any number specified
by the Number field. Select Include in Egress or
Discard in Egress from the drop-down list. The
default is None; the selected number is passed
transparently (if present), without change. Options
are: discardInEgress includeInEgress
none
- natureOfAddress - The Nature of Address for the
resulting number when this rule is executed. Options
are:
- numberLength - The total number of digits in the
manipulated number. The PSX will truncate the
number to the specified length if it is currently greater
than the specified length.
- numberingPlanIndicator - The Numbering
Plan Indicator for the resulting number when this rule
is executed. Options are:
data
ignore isdn
none
offsetUnused private spare0Unknown
spare1
spare2 spare3 spare4
spare5
spare6
spare7
telephony telex
- presentation - The calling party number
presentation type to be used. Options are:
6–48
restricted spare 550-05337 — Version 0.3 — Release V03.00.00
- screening
- Specifies
the Do
calling
party without
number
and Proprietary. All
Rights Reserved.
not distribute
permission.
screening type to be used. Options are:
TABLE 6–6
Profiles
Parameter
ruleType
(continued)
Field
Length
N/A
Description
networkProvidedNotScreened
none
- numberType - The type of number with which to
associate this rule. Options are:
Options are:
billingNumber
calledNumber
callingNumber
contractorNumber
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnDestination
gnDialedDigits
gnNQI=252
gnNQI=253
gnNQI=254
gnPortedDialed
location
outpulseNumber
pretranslated
redirecting
redirection
twoStageCollected
parameter
- additionalCategory - The additional CPC
information to use as a matching criterion. Options are:
- informationMobile1 - Options are: any
inflight maritime pager
auto
- userName - The additional calling party category
(CPC) name to use in the PM rule. Options are:
- mobile1
- mobile2 - Options are: analog any
iridium njtacs nstar
pdc800Mhz pdc1500Mhz
550-05337 — Version 0.3 — Release V03.00.00cdma800Mhz
6–49
Profiles
TABLE 6–6
Parameter
ruleType
(continued)
Field
Length
N/A
Description
- informationMobile2 - Options are: analog any
cdma800Mhz iridium njtacs nstar pdc800Mhz
pdc1500Mhz
- pstn1 - Options are: any
trainPublicPhone
pinkPublicPhone
- parameterType - Options are:
additionalCategory
callingName
carrierCode
carrierSelectionParameter
causeOfNoId
chargeRateInfoIndicator
cliBlockingIndicator
cpc
dpcIndicator
forwardCallIndicator
jurisdiction
olip
originatingCarrier
originatingChargeArea
paiSipDisplayName
paiTelDisplayName
sipFromDisplayName
transitNetworkSelection
zzCode
- flag - Options are:
discardChargeParametersFromBackwardMessa
ges flag. Options are: disable enable
uri
- hostPortManipulation - Options are:
- portNumber - The port number to be manipulated.
Must be 0-65535. Default value is 999.
- characterString - For variable replacement, the
type of character from which to extract the
replacement characters. Options are: calledUri
callingUri fromUri none paiSipUri
toUri
6–50
TABLE 6–6
Profiles
Parameter
ruleType
(continued)
Field
Length
N/A
Description
- type - Options are:
constant - Select this option to use the
constant replacement method for manipulation.
variable - Select this option to use the
variable replacement method for manipulation.
manipulated string. Enter a string.
is the left-most character of the complete string.
- uriParameterManipulation
restricted spare
- scheme - Options are: none
unknown
sip
sips
tel
- userParameter - Options are: ip none phone
unknown
- username - Used to control how the SBC 5x00
interprets the Userinfo component of a URI, as either a
telephone number or a username. This impacts DM/PM
rules applied to the called URI and the calling URI.
Options are: none telephone username
- uriType - The URI type to use for the rule. Options
are: calledUri callingUri fromUri
paiSipUri toUri
- userInfoManipulation - Options are:
6–51
Profiles
TABLE 6–6
Parameter
ruleType
(continued)
Field
Length
N/A
Description
- characterString - For variable replacement, the
type of character from which to extract the
252
253
254
calledInNumber
calledNumber
calledUri
callingName
callingNumber
callingUri
causeOfNoId
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnCollectCallNumber
gnDestination
gnDialedDigits
gnLocalAni
gnPortedDialed
gnThirdPartyNumber
location
none
outpulseNumber
paiSipDisplayName
paiSipUri
paiTelDisplayName
presentationNumber
pretranslated
redirecting
redirection
sipFromDisplayName
toUri
twoStageCollected
6–52
TABLE 6–6
Profiles
Parameter
ruleType
(continued)
Field
Length
Description
N/A
type - Options are:
- value - For constant replacement, the constant to
manipulated string
numberTransl N/A
ationCriteri
a
Specifies number translation criteria.
•
•
•
•
callingNumber
carrier
none
trunkGroup
elementID1
N/A
Specify element ID1.
elementID2
N/A
Specify element ID2.
national
N/A
Specify the calling or called national number. This can be a
number prefix.
country
N/A
Specify the country code.
6–53
Profiles
TABLE 6–6
Parameter
Field
Length
numberingPla N/A
n
Description
Specifies numbering plan.
NOTE
The numbering plans mentioned
below are default plans, but you
can also create your own
numbering plans.
•
•
•
•
•
•
•
•
•
lookupType
N/A
Specifies the ENUM lookup type. Options are:
•
•
•
•
6–54
CHINA_NUM_PLAN
GENERIC_NUM_PLAN
GERMANY_NUM_PLAN
INDIA_NUM_PLAN
ITALY_NUM_PLAN
JAPAN_NUM_PLAN
MEXICO_NUM_PLAN
NANP_ACCESS
UK_NUM_PLAN
e911
enumCnam
enumLnp
enumSipAor
TABLE 6–6
Profiles
Parameter
Field
Length
lengths
N/A
Description
The minimum and maximum lengths for various number
types. Options are:
•
•
•
•
•
areaCode
exchangeCode
line
nationalNumber
subscriberNumber
NOTE
The options listed above have
the following max and min
parameters:
• max - Must be 0-999. Default value is 4.
• min - Must be 0-999. Default value is 4.
prefixProfil N/A
e
Specifies prefix profile:
NOTE
The prefix profiles mentioned
below are default profiles, but
you can also create your own
prefix profiles.
•
•
•
•
•
•
•
•
•
CHINA_DIAL_PLAN
GERMANY_DIAL_PLAN
ITALY_DIAL_PLAN
MEXICO_DIAL_PLAN
UK_DIAL_PLAN
GENERIC_DIAL_PLAN
INDIA_DIAL_PLAN
JAPAN_DIAL_PLAN
NA_DIAL_PLAN
Command Example
% show profiles digitParameterHandling
dmPmCriteria dmpm1 {
parameterPresenceCheck doesntExist;
}
6–55
Profiles
dmPmRule rule1;
numberTranslationCriteria NTC none 2 2 3 4 {
lookupType enumSipAor;
}
numberingPlan CHINA_NUM_PLAN {
prefixProfile CHINA_DIAL_PLAN;
lengths {
nationalNumber {
min 8;
max 31;
}
subscriberNumber {
min 2;
max 7;
}
line {
min 4;
max 4;
}
exchangeCode {
min 3;
max 3;
}
areaCode {
min 2;
max 4;
}
}
}
6–56
Digit Profile
Profiles
Digit Profile
This object allows you to configure profile defining digit generation and digit
detection.
Command Syntax
set profiles digitProfile <digitProfile> type dtmf
<dtmfDetect>
frequenceRange <frequenceRange>
minOffDuration <minOffDuration>
minOnDuration <minOnDuration>
minPower <minPower>
twistCutoff <twistCutoff>
set profiles digitProfile <digitProfile> type dtmf
<dtmfGenerate>
break <break>
make <make>
power <power
set profiles digitProfile <digitProfile> type mfr1
<mfr1Detect>
frequenceRange <frequenceRange1>
minOffDuration <minOffDuration1>
minOnDuration <minOnDuration1>
minPower <minPower1>
<mfr1Generate>
break <break>
make <make1>
makeKp <makeKp1>
power <power1>
<mfr2Detect>
6–57
Profiles
Digit Profile
maxPulseDuration <maxPulseDuration>
postPulseDelay <postPulseDelay>
<mfr2Generate>
break <break>
finalDigitDelay <finalDigitDelay>
make <make2>
maxFwdOffDuration <maxFwdOffDuration>
maxFwdOnDuration <maxFwdOnDuration>
power <power>
prePulseDelay <prePulseDelay>
show profiles digitProfile displaylevel <displaylevel>
show profiles digitProfile dtmfDetect
frequenceRange <frequenceRange>
minOffDuration <minOffDuration>
minOnDuration <minOnDuration>
minPower <minPower>
twistCutoff <twistCutoff>
show profiles digitProfile dtmfGenerate
break <break>
make <make>
power <power
show profiles digitProfile mfr1Detect
6–58
Digit Profile
Profiles
show profiles digitProfile mfr1Generate
break <break>
make <make1>
makeKp <makeKp1>
power <power1>
show profiles digitProfile mfr2Detect
maxPulseDuration <maxPulseDuration>
postPulseDelay <postPulseDelay>
show profiles digitProfile mfr2Generate
break <break>
finalDigitDelay <finalDigitDelay>
make <make2>
maxFwdOffDuration <maxFwdOffDuration>
maxFwdOnDuration <maxFwdOnDuration>
power <power>
prePulseDelay <prePulseDelay>
show profiles digitProfile type <type>
6–59
Profiles
Digit Profile
Command Parameters
TABLE 6–7
Digit Profile Parameters
Parameter
Field
Length
digitProfile 1-23
dtmfDetect
N/A
frequenceRan N/A
ge
Description
Specifies the user name of this digit profile.
Specifies various attributes of the digit detection.
Specifies the range of the frequency tolerances for digit
detection. The possible values are:
•
•
•
•
medium
narrow
wide
wider
minOffDurati N/A
on
Specifies the minimum inter digit duration in milliseconds
for digit detection. The value must be in increments of 5
ms. Must be 25-80 in millisecond; default value is 25.
minOnDuratio N/A
n
Specifies the minimum tone duration in milliseconds
required for digit detection. Must be 25-80 in millisecond;
default value is 35.
minPower
N/A
Specifies the minimum power level in dBm required for digit
detection. Must be -45 to -25 in dBm; default value is -45.
twistCutOff
N/A
Twist is the ratio of high group power to low. The twist
ratios below the twist cutoff will result in digit detection.
Twist ratios above the twist cutoff will result in digit
rejection. Must be in the range of 4dB-12dB in increments
of 2dB; default value is 8dB.
dtmfGenerate N/A
Specifies various digit generation attributes.
break
N/A
Specifies silence between generated digits in milliseconds.
Must be 0-8000 in milliseconds.
make
N/A
Specifies the duration of generated digits in milliseconds.
Must be 0-8000 in millisecond; default value is 100.
power
N/A
Specifies the digit generation power level in dBm. Power
level ranges from -50 dBm (minimum power) to +3 dBm
(maximum power) in dBm. Must be -50 to +3 in
milliseconds; default value is -10.
frequenceRan N/A
ge1
Specifies the frequency tolerances for digit detection. The
• medium
• narrow
• wide
6–60
Digit Profile
TABLE 6–7
Parameter
Profiles
Digit Profile Parameters (Continued)
Field
Length
Description
minOffDurati N/A
on1
Specifies the minimum inter digit duration in milliseconds
for digit detection. The value must be in increments of 5ms.
For DTMF digits, the value must be between 25ms and
80ms. For MF digits, the value must be between 10ms and
100ms. Enter value in range of 10-100 in millisecond;
minOnDuratio N/A
n1
Specifies the minimum tone duration in milliseconds
required
for digit detection. The value must be in
increments of 5ms.
Enter value in range of 25-100 in
millisecond; default value is 25.
minPower1
N/A
Specifies the minimum power level in dBm required for digit
detection. Enter value in range of -45 to -25 in dBm; default
value is -30.
make1
N/A
makeKp
N/A
Specifies duration of generated KP digit in milliseconds.
Only applicable if digit type is MFR1. Must be 0-8000 in
power1
N/A
Specifies digit generation power level in dBm. Power level
ranges from -50 dBm (minimum power) to +3 dBm
(maximum power). Must be -50 to +3 in dBm; default value
is -7.
maxPulseDurat N/A
ion
Specifies the maximum allowed duration of a received
pulsed MF tone. Only applicable if digit type is MFR2. Must
be 0-8000 in millisecond; default value is 1000.
postPulseDel N/A
ay
Specifies the duration after a pulse signal is transmitted, in
which no forward signals are recognized. Applicable for
MFCR2 digit detection only. Must be 0-8000 in millisecond;
finalDigitDel N/A
ay
Specifies the minimum interval after sending of the last
backward compelled signal is complete that an answer line
signal can be applied in the backward direction. For
MFCR2 digit generation only. Must be 0-8000 in
make2
N/A
maxFwdOffDura N/A
tion
Specifies the maximum amount of time between the
removal of a forward signal and the sending of the next
forward signal. Applicable for MFCR2 digit generation only.
Must be 100-60000 in milliseconds; default value is 27000.
maxFwdOnDura N/A
tion
Indicates the maximum amount of time a forward signal is
sent. Applicable for MFCR2 digit generation only. Must be
100-60000 in millisecond; default value is 15000.
6–61
Profiles
TABLE 6–7
Digit Profile
Digit Profile Parameters (Continued)
Parameter
Field
Length
prePulseDela N/A
y
displaylevel
1-64
Description
Delay between the end of the last compelled signal and the
start of a backward pulsed signal. Applicable for MFCR2
digit detection only. Must be 0-8000 in millisecond; default
value is 100.
commands.
Command Example
dtmf - dtmfDetect
% show profiles digitProfile Test1
type dtmf;
dtmfDetect {
minPower
-25;
minOnDuration
25;
minOffDuration 25;
frequenceRange narrow;
twistCutoff
9;
}
dtmfGenerate {
power 2;
make
3445;
break 788;
}
type mfr1
type mfr1;
mfr1Generate {
power
-7;
make
4555;
break
4566;
makeKp 105;
}
mfr1Detect {
minPower
6–62
-30;
Digit Profile
Profiles
minOnDuration
25;
minOffDuration 15;
frequenceRange medium;
}
type - mfr2
type mfr2;
mfr2Generate {
power
-10;
make
150;
break
455;
prePulseDelay
100;
maxFwdOnDuration
566;
maxFwdOffDuration 2700;
finalDigitDelay
50;
}
mfr2Detect {
minPower
-25;
minOnDuration
25;
minOffDuration
15;
frequenceRange
medium;
maxPulseDuration 1000;
postPulseDelay
234;
}
6–63
Profiles
DTMF Trigger
DTMF Trigger
This object allows you to configure a profile defining conditions for triggering on
DTMF digit strings.
Command Syntax
set profiles dtmfTrigger <dtmfTrigger>
interdigitTimeout <interdigitTimeout>
longdigitDuration <longdigitDuration>
pattern <pattern>
state <state>
show profiles dtmfTrigger <dtmfTrigger>
interdigitTimeout <interdigitTimeout>
longdigitDuration <longdigitDuration>
pattern <pattern>
state <state>
delete profiles dtmfTrigger <dtmfTrigger>
6–64
DTMF Trigger
Profiles
Command Parameters
TABLE 6–8
DTMF Trigger Parameters
Parameter
Field
Length
dtmfTrigger
N/A
Description
Specifies the profile defining conditions for triggering on
DTMF digit strings. The DTMF trigger is allowed for the
profiles: ingress and egress.
interdigitTi 0-65535 Specifies interdigit timer in milliseconds. If 0, then timer is
meout
disabled. Enter value in range of 0-65535 in milliseconds.
Default value is 4000 milliseconds.
longdigitDur 0-65535 Specifies minimum duration in milliseconds for a digit to be
ation
considered long.
If 0, then long digits are disabled. Enter value in range of
0-65535 in milliseconds. Default value is 2000
milliseconds.
pattern
N/A
Specifies the trigger pattern.
state
N/A
Specifies the administrative state of this dtmf trigger.
• disabled - Disables the DTMF trigger.
• enabled - Enables the DTMF trigger.
displaylevel
1-64
commands.
Command Example
% show profiles dtmfTrigger
dtmfTrigger egress {
state
enabled;
pattern
3;
interdigitTimeout 5000;
longdigitDuration 2000;
}
dtmfTrigger ingress {
state
enabled;
pattern
4;
interdigitTimeout 3000;
longdigitDuration 4000;
}
6–65
Profiles
Media
Media
The SBC 5x00 uses Packet Service Profile and the Codec Entry to control the
media characteristics for calls.
Annoucement Package
SBC 5x00 supports playing announcements, tones, and can collect digit. PSX
returns the tones/announcement profile and announcement or tone to be played
in policy/trigger response. SBC 5x00 plays out the specified announcement/tone
using the specified profile.
You can customize announcements by provisioning the announcement packages.
An announcement package supports provisioning up to 16 announcement names
to segment id mapping. For more information on configuring Media Profiles
through Embedded Management Application, refer to SBC 5x00 EMA User
Guide.
Command Syntax
To set the annoucement package for a node:
% set profiles media annoucementPackage <annoucementPackage>
element <element>
packageID <packageID>
To display the recently created annoucement packages:
% show profiles media annoucementPackage <annoucementPackage>
To delete the recently created annoucement packages:
% delete profiles media annoucementPackage
<annoucementPackage>
TABLE 6–9
Annoucement Package parameters
Parameter
Field Length
Description
announcementPackage
NA
Specifies a table which contains the
annoucement packages for a node.
element
NA
Specifies a table which contains elements
that binds announcement names to
segment ID values for a given
annoucement package.
packageID
NA
Specifies the annoucement package
identifier defined by the Sonus softswitch
for this package.
6–66
Media
Profiles
Codec Entry
Audio codecs are configured in the Packet Service Profile. Video calls and audio
only calls can use these audio codecs in pass-through or direct media mode only
(that is, special DSP treatments and transcoding are not applicable to the calls
using these audio codecs).
Audio codec relay is supported in SIP-SIP, H.323-H.323 as well as SIP-H.323
interworking calls. Refer the SBC 5x00 2.1 Operations guide (550-02879) to see
the list of audio codecs supported by the SBC 5x00.
Command Syntax
% set profiles media codecEntry <G711-DEFAULT>
codec <codec>
dtmf <dtmf>
fax <fax>
law <law>
modem <modem>
packetSize <packetSize>
preferredRtpPayloadType <preferredRtpPayloadType>
% set profiles media codecEntry <G711SS-DEFAULT>
codec <codec>
dtmf <dtmf>
fax <fax>
law <law>
modem <modem>
sendSid <sendSid>
% set profiles media codecEntry <G723-DEFAULT|G723ADEFAULT|G726-DEFAULT>
codec <codec>
codingRate <codingRate>
dtmf <dtmf>
fax <fax>
modem <modem>
6–67
Profiles
Media
% set profiles media codecEntry <G729A-DEFAULT|G729AB-DEFAULT>
codec <codec>
dtmf <dtmf>
fax <fax>
modem <modem>
% set profiles media codecEntry <G711-DEFAULT|G711SSDEFAULT|G723-DEFAULT|G723A-DEFAULT|G726-DEFAULT|G729ADEFAULT|G729AB-DEFAULT> codec
<amrBandwidthEfficient|amrCrc|amrCrcInterleaving|amrCrcRobus
tSorting
|amrInterleaving|amrInterleavingRobustSorting|amrIuUp|amrOct
etAligned|amrRobustSorting>
activeCodecSet <activeCodecSet>
dtmf <dtmf>
fax <fax>
fecRedundancy <fecRedundancy>
modem <modem>
<amrwbBandwidthEfficient|amrwbCrc|amrwbCrcInterleaving|amrwb
CrcInterleavinRobustSorting|amrwbCrcRobustSorting|amrwbOctet
Aligned>
dtmf <dtmf>
fax <fax>
modeSet <modeSet>
modem <modem>
<amrwbInterleaving|amrwbInterleavingRobustSorting|g728|g729a
|g729ab|g7291|efr|evrcb1Fr|msrta8|msrta16|silk8|silk12|silk1
6|silk24>
6–68
Media
Profiles
dtmf <dtmf>
fax <fax>
modem <modem>
<evrc|evrc0|evrc1Fr|evrcb|evrcb1>
dtmf <dtmf>
fax <fax>
modem <modem>
silenceSuppression <silenceSuppression>
% set profiles media codecEntry <G711-DEFAULT|G711SSDEFAULT|G723-DEFAULT|G723A-DEFAULT|G726-DEFAULT|G729ADEFAULT|G729AB-DEFAULT> codec <evrcb0>
codingRate
dtmf <dtmf>
fax <fax>
modem <modem>
% set profiles media codecEntry <G711-DEFAULT|G711SSDEFAULT|G723-DEFAULT|G723A-DEFAULT|G726-DEFAULT|G729ADEFAULT|G729AB-DEFAULT> codec <g711>
dtmf <dtmf>
fax <fax>
law <law>
modem <modem>
% set profiles media codecEntry <G711-DEFAULT|G711SSDEFAULT|G723-DEFAULT|G723A-DEFAULT|G726-DEFAULT|G729ADEFAULT|G729AB-DEFAULT> codec <g711ss>
6–69
Profiles
Media
dtmf <dtmf>
fax <fax>
law <law>
modem <modem>
sendSid <sendSid>
<g722|g726|g726ss|g7221|g7221ss|g7231|g7231a|ilbc|ilbcss>
dtmf <dtmf>
fax <fax>
modem <modem>
% set profiles media codecEntry <G711-DEFAULT|G711SSDEFAULT|G723-DEFAULT|G723A-DEFAULT|G726-DEFAULT|G729ADEFAULT|G729AB-DEFAULT> codec <g728ss>
dtmf <dtmf>
fax <fax>
modem <modem>
% show profiles media
annoucementPackage <annoucementPackage>
codecEntry <codecEntry>
toneAndAnnoucementProfile <toneAndAnnoucementProfile>
tonePackage <tonePackage>
toneProfile <toneProfile>
% show profiles media codecEntry <codecEntry>
activeCodecSet <activeCodecSet>
codec <codec>
6–70
Media
Profiles
dtmf <dtmf>
fax <fax>
fecRedundancy <fecRedundancy>
law <law>
modeSet <modeSet>
modem <modem>
sendSid <sendSid>
% delete profiles media codecEntry <codecEntry>
6–71
Profiles
Media
Command Parameters
TABLE 6–10 Codec Entry Parameters
Parameter
Field
Length
codecEntry
N/A
Description
Specifies the parameters for a particular codec. Options
are:
•
•
•
•
•
•
•
codec
N/A
Select the codec. Following are the supported codecs:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
6–72
G711-DEFAULT
G711SS-DEFAULT
G723-DEFAULT
G723A-DEFAULT
G726-DEFAULT
G729A-DEFAULT
G729AB-DEFAULT
amrBandwidthEfficient
amrCrcInterleaving
amrInterleaving
amrIuUp
amrRobustSorting
amrwbCrc
amrwbCrcInterleavingRobustSorting
amrwbInterleaving
amrwbOctetAligned
amrCrc
amrCrcRobustSorting
amrInterleavingRobustSorting
amrOctetAligned
amrwbBandwidthEfficient
amrwbCrcInterleaving
amrwbCrcRobustSorting
amrwbInterleavingRobustSorting
efr
evrc0
evrc1Fr
evrcb0
evrcb1Fr
g711ss
Media
Profiles
Parameter
codec
(continued)
Field
Length
N/A
activeCodecSe N/A
t
Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
g726
g728
g729a
g7221
g7231
g7291
ilbcss
msrta16
silk12
silk24
evrc
evrc1
evrcb
evrcb1
g711
g722
g726ss
g728ss
g729ab
g7221ss
g7231a
ilbc
isac
msrta8
silk8
silk16
The active code set is applicable only for AMR codecs.
Specify the allowed coding rate for the AMR narrow-band
codecs. Multiple rates may be selected using comma (,).
Valid values are:
•
•
•
•
•
•
•
•
0-4.75kbps
1-5.15kbps
2-5.90kbps
3-6.70kbps
4-7.40kbps
5-7.950kbps
6-10.20kbps
7-12.20kbps
6–73
Profiles
Media
Parameter
Field
Length
modeSet
N/A
Description
The modeSet codec set is applicable only for AMRWB
codecs. The possible values are:
•
•
•
•
•
•
•
•
•
dtmf
N/A
0-6.6
1-8.85
2-12.65
3-14.25
4-15.85
5-18.25
6-19.85
7-23.05
8-23.85
Specifies the DTMF. The DTMF maps one or more digit
key sequences to actions and associated scripts for take
back and transfer features such as blind transfer,
consultative transfer, and conference and transfer.
• relay - Type of DTMF relay. Select any one of the relay:
- bothOobAnd2833 - Out-of-Band and RFC 2883 are equally
received and both can be transmitted. This option would
normally be used only in the case where the OOB DTMF
signaling is absorbed and not regenerated. For example, the
OOB DTMF might go to an application server that needs to
detect the DTMF for control purposes but does not process
RTP and the 2833 DTMF would go to the destination media
address as part of the RTP stream.
- eitherOobOrRfc2833 - Out-of-Band and RFC 2833 are
equally received and only one is transmitted. The one
transmitted is the one preferred by the peer or RFC 2833 as
the default.
- none - Leaves the DTMF tones in-band as encoded audio.
- outOfBand - Applies to SBC 5x00-to-SIP or SBC 5x00-toH.323. Carries DTMF in the signaling protocol.
- rfc2833 - Applies to SBC 5x00-to-SIP, SBC 5x00-to-H.323,
or SBC 5x00-to-SBC 5x00. Encodes DTMF into RTP using a
format and payload type distinct from the audio encoding.
• removeDigits - Enables the removal of DTMF digits from
the media stream. This applies only if DTMF relay is
configured as outOfBand or rfc2833. The default setting is
enable. To disable removal of DTMF digits, select disable.
6–74
Media
Profiles
Parameter
Field
Length
fax
N/A
Description
Specifies the treatment taken when the fax tone is
detected, which can be:
• failureHandling - Specifies the behavior when a fax tone
is detected but the treatment fails for any reason. The
behavior can be:
- continue (Default) - Continue to process the call.
- disconnect - Release the call.
• toneTreatment - Specifies the treatment taken when the
fax tone is detected, which can be:
- disconnect - Disconnect the call when the fax tone is
detected.
- fallbackToG711 - Fall back to G.711 when the fax tone is
detected.
- faxRelay - Switch to fax relay (T.38) when the fax tone is
detected.
- faxRelayOrFallbackToG711 - Switch to fax relay (T.38) if
supported or fall back to G.711 when fax tone is detected.
- ignoreDetectionAllowPeerToNegotiateFaxRelay Accept a T.38 reINVITE (either from a calling party or a called
party) without detecting the fax tone.
- none (Default) - Do nothing when the fax tone is detected.
- notifyPeer - For SIP signaling, notify the peer when the
fax tone is detected and let the peer decide the next action.
NOTE
For G.711 calls, Notify Peer,
Disconnect, Fax Relay, and Fax
Relay or Fallback to G.711 require
a compression resource be
allocated.
fecRedundanc N/A
y
Sets the level for Forward-Error-Correction (FEC)
Redundancy.
The options are 0, 1 and 2. 0 means FEC redundancy is
disabled (this is the default value).
law
N/A
Specifies the law derivation of the egress call, which can
be:
• ALaw
• ULaw
• deriveFromOtherLeg
6–75
Profiles
Media
Parameter
Field
Length
modem
N/A
Description
Specifies the treatment taken when the modem tone is
detected, which can be:
• failureHandling - Specifies the behavior when a modem
tone is detected but the treatment fails for any reason. The
behavior can be:
- continue (Default) - Continue to process the call.
- disconnect - Release the call.
• toneTreatment - Specifies the treatment taken when the
modem tone is detected, which can be:
- applyFaxTreatment - Treat the modem tone as a fax
tone, and apply the fax treatment for the selected codec.
- disconnect - Disconnect the call when the modem tone is
detected.
- fallbackToG711 - Fall back to G.711 when the modem
tone is detected.
- none (Default) - Do nothing when the modem tone is
detected.
- notifyPeer - Notify the peer when the modem tone is
detected and let the peer decide the next action.
packetSize
N/A
The packet size in milliseconds (ms). Options are:
•
•
•
•
•
•
•
preferredRtp 0-128
PayloadType
10
15
20
25
30
35
40
Specifies the preferred Real Time Protocol (RTP) payload
type to be included in the RTP header of the data packet.
Enter a value in the range 0-128. Default is 128.
sendSid
N/A
Enable or disable for sending SIDs.
codingRate
N/A
Coding rate (in kbps) for G.723.1. Options are:
• 5.3
• 6.3
displaylevel
6–76
1-64
commands.
Media
Profiles
Command Example
% show profiles media
codecEntry G711-DEFAULT {
codec
g711;
packetSize
10;
preferredRtpPayloadType
128;
fax {
failureHandling continue;
toneTreatment
none;
}
modem {
failureHandling continue;
toneTreatment
none;
}
law
deriveFromOtherLeg;
dtmf {
relay
none;
removeDigits enable;
}
}
P2P Transcoding command example
Perform the following commands to make a transcoded call between G711 ulaw
to G729.
% set profiles media codecEntry codec_in codec g711 law ULaw
% set profiles media codecEntry codec_in packetSize 20
% set profiles media packetServiceProfile profile_in
% set profiles media packetServiceProfile profile_in codec
codecEntry1 codec_in
packetToPacketControl codecsAllowedForTranscoding thisLeg
g711u
packetToPacketControl codecsAllowedForTranscoding
otherLeg g729
6–77
Profiles
Media
% set profiles media codecEntry codec_out codec g729a
% set profiles media codecEntry codec_out packetSize 20
% set profiles media packetServiceProfile profile_out_1
% set profiles media packetServiceProfile profile_outcodec
codecEntry1 codec_out
% set profiles media packetServiceProfile
profile_outpacketToPacketControl
codecsAllowedForTranscoding thisLeg g729
profile_outpacketToPacketControl
codecsAllowedForTranscoding otherLeg g711u
Assign the ingress profile to ingress trunk group & egress profile on Egress
ipPeer:
% set addressContext a1 zone INTERNAL sipTrunkGroup EAST_INT
policy media packetServiceProfile profile_in
% set addressContext a1 zone EXTERNAL ipPeer EAST_ext_peer
policy packetServiceProfile profile_out
Get statistics of ongoing calls by executing the following commands. The GCID for
calls are listed.
% show table global callSummaryStatus
Provide GCID for the following command; output shows media type (passthrough
or transcode):
% show table global callDetailStatus <GCID>
Output of the following command gives codec details:
% show table global callMediaStatus <GCID>
Output of the following command gives PxPad utilization:
% show table global callResourceDetailStatus <GCID>
Packet Service Profiles
The Packet Service Profile supports up to four audio encoding entries or
CODECs. The SBC 5x00 will negotiate a Codec from the list of Codecs allowed in
the Packet Service Profile. One example of a negotiation scenario occurs when a
call comes into the SBC 5x00 from an H.323 peer. The SBC 5x00 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.
6–78
Media
Profiles
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
honorRemotePrecedence parameter.
Command Syntax
<packetServiceProfile>
aal1PayloadSize <aal1PayloadSize>
codec <codec>
dataCalls <dataCalls>
flags <flags>
honorRemotePrecedence <honorRemotePrecedence>
mediaPacketCos <mediaPacketCos>
packetToPacketControl <packetToPacketControl>
peerAbsenceAction <peerAbsenceAction>
preferredRtpPayloadTypeForDtmfRelay
<preferredRtpPayloadTypeForDtmfRelay>
rtcpOptions <rtcpOptions>
secureRtpRtcp <secureRtpRtcp>
silenceFactor <silenceFactor>
silenceInsertionDescriptor <silenceInsertionDescriptor>
t38 <t38>
typeOfService <typeOfService>
videoCalls <videoCalls>
voiceInitialPlayoutBufferDelay
<voiceInitialPlayoutBufferDelay>
% show profiles media packetServiceProfile
codec <codec>
flags <flags>
6–79
Profiles
Media
t38 <t38>
% delete profiles media packetServiceProfile
codec <codec>
flags <flags>
t38 <t38>
6–80
Media
Profiles
Command Parameters
TABLE 6–11 Packet Service Profiles Parameters
Parameter
Field
Length
packetServic N/A
eProfile
Description
Specifies the packet service profile. The available packet
service profiles are:
•
•
•
•
•
DEFAULT
G711_PSP
G729_PSP
SIPART_PSP
SIPART_PSP_S35
aal1Payload
Size
0-999
Specifies the aa11 payload type to be used for data calls.
Default is 47.
codec
N/A
Specifies the codec entry with priority.
• codecEntry1 - This attribute specifies the codec entry with a
priority of 1. For each codec entry, select the default codec entry
ID. Available IDs are:
- G711-DEFAULT
- G711SS-DEFAULT
- G711SS_NONE_NONE_NONE
- G711_NONE_NONE_NONE
- G723-DEFAULT
- G723A-DEFAULT
- G723_NONE_NONE_OOB2833
- G726-DEFAULT
- G726_RL_FB_OOB2833
- G729A-DEFAULT
- G729AB-DEFAULT
- G729AB_NONE_NONE_NONE
- G729A_NONE_NONE_NONE
- G729_RLFB_FB_OOB2833
- G7231A_NONE_NONE_NONE
- ILBC_NONE_NONE_NONE
priority of 2. For each codec entry, select the default codec
entry ID as specified in codecEntry1.
ID as specified in codecEntry1.
ID as specified for codecEntry1.
6–81
Profiles
Media
TABLE 6–11 Packet Service Profiles Parameters (Continued)
Parameter
Field
Length
Description
dataCalls
N/A
Specifies the data calls:
• initialPlayoutBufferDelay - Used for G.711 only. Must
• packetSize - This attribute specifies the maximum packet
size of the data packet (Kilobits). Options are: 10 20 30
40
• preferredRtpDataPayloadType - This attribute specifies
the RTP Payload Type to be included in the RTP header
of the data packet. Must be 0-127. Default value is 56.
6–82
Media
Profiles
Parameter
Field
Length
Description
flags
N/A
Specifies the flag.
• digitDetectSendEnabled - Digit Detect Send Enabled
Flag. Specifies whether digit detection is enabled on digits sent
to the network. Options are:
- disable - SBC 5x00 digit detection on digits sent to
the network is disabled.
- enable - SBC 5x00 digit detection on digits sent to
the network is enabled.
• disallowDataCalls - Disallow Data Calls Flag. Specifies
whether data calls are allowed. Options are:
- disable - If disabled, digit data calls are allowed.
- enable - If enabled, digit data calls are rejected.
• useDirectMedia - Use Direct Media Flag. Options are:
- disable - When disabled, the SBC 5x00 does not
use direct media.
- enable - When enabled, the SBC 5x00 uses direct
media if possible.
• validatePeerSupportForDtmfEvents - Validate Peer
Support For DTMF Events. Options are:
- disable - When enabled, the SBC 5x00 validates
the presence of DTMF events in the offer or answer
from peers that support RFC 4733. If DTMF Relay is
enabled, and events 0 - 15 are received (and no other
combination or subset of events), SBC 5x00 forwards
them on in the egress leg to this peer using the named
event RTP payload. When the SBC 5x00 is configured
for a pass-through call and it receives DTMF events
other than 0-15 from the ingress peer, it does not offer
any DTMF events to the egress endpoint.
- enable - When disabled, SBC 5x00 does not
validate the presence of DTMF events in the offer or
answer from the peer. If DTMF relay is enabled, SBC
5x00 transmits DTMF digits received from the other leg
to this peer using the named event RTP payload. This
is the default. This control should be enabled for all
peer devices that support RFC 4733.
6–83
Profiles
Media
Parameter
Field
Length
honorRemoteP N/A
recedence
Description
Specifies whether the audio encoding priority order of the
local packet service profile takes precedence over the
remote peers audio encoding priority order when creating
the priority order of the audio encodings that are common to
both. Options are:
• disable (default) - When disabled the local audio encoding
priority order takes precedence. Disabled also makes the local
Secure RTP/RTCP settings and crypto suite priority order take
precedence.
• enable - When enabled the remote peer’s audio encoding
priority order takes precedence. For ingress call legs, Enabled
also makes the remote peer's Secure RTP/RTCP settings and
crypto suite priority order take precedence.
mediaPacketC N/A
os
6–84
Specifies the Class of Service (COS) value to be set in the
IEEE 802.1D User Priority field of media packets transmitted
on a call leg that uses this Packet Service Profile. This
parameter only has an effect if the network interface
supports 802.1Q tagged Ethernet frames. Must be 0 - 7;
default is 0 (best effort).
Media
Profiles
Parameter
Field
Length
packetToPack N/A
etControl
Description
Specifies packet to packet control parameters:
• transcode - Options are: conditional
determinedByPspForOtherLeg only
transcoderFreeTransparency. Options are:
- codecsAllowedForTranscoding - Specifies the
codecs that allow transcoding. Options are:
- otherLeg - Options are: amr efr evrc
g711a g711u g722 g726 g729 g7222
g7231 ilbc t38
- thisLeg - Options are: amr efr evrc g711a
g711u g722 g726 g729 g7222 g7231
ilbc t38
- conditionsInAdditionToNoCommonCodec - The SBC
5x00 performs transcoding when any of the specified
conditions are met, including no common codec on ingress
and egress legs. Options are:
- differentDtmfRelay - Different DTMF Relay Flag.
When enabled, the SBC 5x00 performs transcoding
when the ingress and egress call legs use different
DTMF relay methods. When disabled, SBC 5x00
transcoding is not determined by different DTMF relay
methods.
- differentPacketSize - Different PAcket Size flag.
When enabled, the SBC 5x00 performs transcoding
when the ingress and egress call legs use different
packet sizes. When disabled, SBC 5x00 transcoding is
not determined by different packet size.
- differentSilenceSuppression - Different
Silence Suppression Flag. When enabled, the SBC
5x00 performs transcoding when the ingress and egress
call legs use different silence suppression methods.
When disabled, SBC 5x00 transcoding is not
determined by different silence suppression methods.
- honorOfferPreference - Honor Offer Preference
Flag. When enabled, this packet service profile is
applied to either ingress or egress call leg, the codec
offer list of the remote peer is given preference. This
option available only when Transcode=Conditional.
peerAbsence
Action
N/A
preferredRtp N/A
PayloadTypeF
orDtmfRelay
Specifies peer absence action. The available options are:
• none
• peerAbsenceTrap
• peerAbsenceTrapAndDisconnect
Specifies the preferred RTP payload type to be set in the
RTP header of audio packets for this encoding. Must be 0 128, default value is 128.
6–85
Profiles
Media
Parameter
Field
Length
rtcpOptions
N/A
Description
Specifies Real Time Control Protocol (RTCP) options 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.
The RTCP options are:
• enable - Use RTCP for the call. The actions are:
- packetLossAction - Specifies packet loss action. Options
are none, packetLossTrap and
packetLossTrapAndDisconnect.
- packetLossThreshold - This parameter is required if
RTCP is enabled. Must be 0 - 32767. Default value is 0.
- terminationForPassThrough - Specifies RTCP
termination for pass-through calls. By default, RTCP is relayed
between the end points for pass-through calls. If termination is
enabled, then RTCP sessions for each leg are terminated by
the SBC 5x00. Options are disable, enable.
• disable (default) - do not use RTCP for the call.
secureRtpRtc N/A
p
Specifies whether secure RTP Real Time Control Protocol
(RTCP) is enabled for the call:
• cryptoSuiteProfile - A unique identifier for the crypto suite
profile.
• flags - Select the flags:
- allowFallback - Allow Fallback Flag. Options are disable
and enable.
- enableSrtp - Enable SRTP Flag. Options are disable and
enable.
silenceFacto N/A
r
Specifies the percent of call time that silence is expected.
This parameter is used to reduce expected call bandwidth.
silenceInser N/A
tionDescript
or
For CODEC G711SS, specifies whether Silence Insertion
Descriptor (SID) packets are sent during a call:
6–86
• g711SidRtpPayloadType - Specifies the G.711 Silence
Insertion Descriptor (SID) RTP payloadType. Must be 0-127,
• heartbeat - Specifies that the SID packets are sent within a
minimal interval during a silence period and at least one SID
packet must be sent within a SID maximum packet time.
Options are enable and disable.
Media
Profiles
Parameter
Field
Length
Description
t38
N/A
Specifies T.38 data rate management type.
dataRateManagementType:
• type1LocalGenerationOfTcf - 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.
• type2TransferOfTcf (default) - Type 2 data rate
management requires that the TCF be transferred from the
sending gateway to the receiving gateway rather than having
the receiving gateway generate it locally. Speed selection is
done by the gateways in the same way as they would on a
regular PSTN connection. Data rate management type 2
requires the use of UDP and is not recommended for use with
TCP.
ecm
Specifies whether to allocate DSP resources, when
available, for T.38 Error Correction Mode (ECM) calls:
• enabled - allocate an ECM-capable DSP resource for the call.
• disabled (default) - use normal resource allocation.
lowSpeedNumberOfRedundantPackets
This field specifies the number of redundant IFP messages
sent in a UDP packet for T.38 low speed fax transmission.
This field applies only if the T.38 error correction type is
redundancy. Must be 0-2, default is 1.
maxBitRate
Specifies the T.38 Maximum Bit Rate, which controls and
manipulates bits 11, 12, 13, and 14 in the DIS command
received by SBC 5x00 from either the TDM circuit interface
or the T.38 packet interface:
•
•
•
•
2.4Kbits_s - for modem type ITU-T V.27 ter fall-back mode
4.8Kbits_s - for modem type ITU-T V.27 ter
9.6Kbits_s - for modem types ITU-T V.27 ter and V.29
14.4Kbits_s (default) - for modem types ITU-T V.27 ter, V.29,
and V.17.
This setting is used to constrain the type of modem
modulation schemes to be used and thus indirectly effect the
data bit rate. For example, if the T.38 Maximum Bit Rate is
set to 9600 bps and the incoming DIS is set to ITU-T V.27
ter, V.29, and V.17, then the final egress DIS.
6–87
Profiles
Media
Parameter
Field
Length
Description
t38
N/A
numberOfRedundantPackets - For high-speed fax relay,
(continued)
specifies the number of redundant Internet Facsimile
Protocol (IFP) messages sent in a User Datagram Packet
(UDP) for fax transmission. Options are 0, 1 and 2.
typeOfServic 0-999
e
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. Default value is 0.
videoCalls
N/A
Specifies video call parameters.
• audioOnlyIfVideoIsPrevented - This attribute specifies
whether the call should continue with the audio only portion if
the video cannot be established for any reason. Select any one
of the option: disable or enable.
• maxVideoBandwith - This attribute specifies the maximum
bandwidth in Kbps utilized by the video stream. Enter the value
between 0-2048. Default value is 0.
• videoBandwidthReductionFactor - This attribute
specifies the rate in which the maximum video bandwidth
should be reduced when the allocation of IP resources is
performed. Enter the value between 0-100. Default value is 0.
voiceInitial N/A
PlayoutBuffe
rDelay
Specifies the size of the initial playout buffer required to
absorb the maximum expected data packet delay across the
network, in milliseconds. Must be 1-50, in increments of 1
ms. Default is 10 (milliseconds).
This is the initial playout delay for calls with a data bearer
channel, for example, ISDN 64K data calls. This value is
configured separately from the initial playout delay for voice
channels (VOICE INITIAL PLAYOUT BUFFER DELAY) so
providers can trade off delay on data calls versus the
likelihood of jitter causing delay changes while the playout
buffer adapts. Some data bearer calls are very sensitive to
delay changes (such as H.320 video conferencing) so a
higher initial delay should reduce the chance of jitter bursts
causing problems.
Command Example
% show profiles media packetServiceProfile
packetServiceProfile DEFAULT {
dataCalls {
preferredRtpDataPayloadType 56;
initialPlayoutBufferDelay
6–88
50;
Media
Profiles
packetSize
20;
}
silenceFactor
40;
typeOfService
0;
10;
rtcpOptions {
rtcp disable;
}
silenceInsertionDescriptor {
g711SidRtpPayloadType 19;
heartbeat
enable;
}
aal1PayloadSize
47;
codec {
codecEntry1 G711-DEFAULT;
codecEntry2 "";
codecEntry3 "";
codecEntry4 "";
}
packetToPacketControl {
transcode conditional;
conditionsInAdditionToNoCommonCodec {
differentDtmfRelay
disable;
differentPacketSize
disable;
differentSilenceSuppression disable;
honorOfferPreference
disable;
}
codecsAllowedForTranscoding {
thisLeg
"";
otherLeg "";
}
}
6–89
Profiles
Media
Tone and Announcement Profile
This feature is used to provision a tone and announcement profile, which specifies
an announcement package and/or signaling tone package for the SBX to use play
announcements or signaling tones to calling or called parties. Tone and
announcement profiles are assigned to ingress or egress trunk groups. Also, use
this feature to provision local ring back tones for the SBX, which the SBX plays to
callers upon receipt of an alert indication without a media stream or without an
indication of in-band tones.
Command Syntax
To create the tone and annoucement profile:
% set profiles media toneAndAnnoucementProfile
<toneAndAnnoucementProfile>
To set the local ring back feature:
<toneAndAnnoucementProfile> localRingBackTone
signalingTonePackageState <signalingTonePackageState>
signalingTonePackageState <enable | disable>
To make the inband tone available for local ring back feature:
makeInbandToneAvailable <state>
makeInbandToneAvailable <enable | disable>
To set flags for local ring back feature:
<toneAndAnnoucementProfile> localRingBackTone flags <flag>
usethislrbtforEgress <enable | Disable>
usethislrbtforIngress <enable | Disable>
To set precedence:
<toneAndAnnoucementProfile> localRingBackTone precedence
<precedence>
precedence <lower | higher>
To a custom tone package:
6–90
Media
Profiles
signalingTonePackage <signalingToneProfile>
SignalingTonePackage <DEFAULT | custTonePkg>
To enable tone and announcement feature:
<toneAndAnnoucementProfile> toneAndAnnouncement
announcementPackageState <announcementPackageState>
announcementPackageState <enable | disable>
To set the over riding flag:
<toneAndAnnoucementProfile> toneAndAnnouncement override
<override>
override <enable | disable>
To set the custom annoucement package:
<toneAndAnnoucementProfile> toneAndAnnouncement
sigTonePackage <sigTonePackage>
sigTonePackage <DEFAULT | custTonePkg>
TABLE 6–12 Tone and Annoucement Profile parameters
Parameter
Field Length
Description
toneAndAnnoucementProf NA
ile
Specifies the announcement and/or
signaling tone package for the SBX to use
on this trunk group. Also specifies the local
ring back tone to use on this trunk group.
localRingBackTone
NA
Specifies whether the local ring back tone
should be enabled or not. The options are:
enable and disable.
toneAndAnnoucement
NA
Specifies whether the tone and
announcement feature should be enabled
or not. The options are: enable and
disable.
6–91
Profiles
Media
Tone Package
This object creates and configures a tone package, which defines a set of call
progress tones for a given country or carrier. Tone packages are configured by
assigning tone types to tone profiles. You may add a tone type to a tone package.
You may delete a tone type from a tone package. You may modify a tone type
within a tone package by specifying a different tone profile. The tone package
name may be used by the PSX/toneAndAnnouncementProfile.
SBC 5x00 supports a default tone package with a package id of "1". The default
package contains the following tone profile definitions:
•
•
•
•
•
•
•
•
•
•
•
•
Dial
Ring
Busy
Reorder
sit1
sit2
sit3
callWaiting1
callWaiting2
callWaiting3
callWaiting4
cpcAlerting
Command Syntax
To show seeded DEFAULT tone package:
% show profiles media tonePackage DEFAULT
packageId 1;
element busy {
toneProfile defBusy;
}
element dial {
toneProfile defDial;
}
element ring {
toneProfile defRing;
}
element sit1 {
toneProfile defSit1;
}
element sit2 {
6–92
Media
Profiles
}
element sit3 {
}
element reorder {
toneProfile defReorder;
}
element cpeAlerting {
toneProfile defCpeAlerting;
}
element callWaiting1 {
toneProfile defCallWaiting1;
}
}
}
To create a tone package:
% set profiles media tonePackage custTonePkg packageID
<packageID>
% set profiles media tonePackage custTonePkg toneType ring
toneProfile <toneProfile>
defBusy
defCallWaiting1
defCallWaiting2
defCallWaiting3
defCallWaiting4
defCpeAlerting
defDial
defReorder
defRing
defSit1
defSit2
6–93
Profiles
Media
defSit3
fccBusy
fccDial
fccRingback
To delete a tone package:
% delete profiles media tonePackage custTonePkg
Tone Profile
This object creates and configures a profile for generating a tone consisting of a
single frequency, dual frequency, amplitude-modulated frequencies, or composite.
Select the appropriate CREATE and CONFIGURE commands and parameters for
generating tones with the following signal characteristics:
•
•
•
•
Single Tone
Dula Tone
Modulated Tone
Composite Tone
For more information on Tone Profile and signal characteristics, refer to SBC 5x00
Operations Guide.
Command Syntax
To show seeded tone profile:
% show profiles media toneProfile
defBusy
- The user name of this tone profile.
defCallWaiting1 - The user name of this tone profile.
6–94
defCpeAlerting
defDial
defReorder
defRing
defSit1
defSit2
defSit3
displaylevel
- Depth to show
fccBusy
fccDial
Media
Profiles
fccRingback
Possible match completions:
break1
milliseconds.
- Duration of the first off cadence in
break2
milliseconds.
- Duration of the second off cadence in
break3
milliseconds.
- Duration of the third off cadence in
compositeTone
attributes.
- Configuration of conposite tone
dualTone
- Configuration of dual tone attributes.
generationMethod - Determines the generation method for
the tone.
make1
milliseconds.
- Duration of the first on cadence in
make2
milliseconds.
- Duration of the second on cadence in
make3
milliseconds.
- Duration of the thrid on cadence in
modulatedTone
attributes.
- Configuration of modulated tone
repeat
- Number of overall cadence (1, 2, and 3
in sequence) cycles to generate.
repeat1
- Number of cadence 1 cycles to generate.
repeat2
repeat3
singleTone
- Configuration of single tone attributes.
To create custom tone profile:
% set profiles media toneProfile <toneProfile>
generationMethod <compositeTone | dualTone | modulatedTone
| singleTone>
To delete the custom tone profile crearted:
% delete profiles media toneProfile <toneProfile>
6–95
Profiles
Security
Security
The Security profile supports the following profiles:
•
•
•
•
Crypto Suite Profile
Key Management Protection Profile
IPSec Protection Profile
TLS Profile
Crypto Suite Profile
Crypto Suite profile is used to negotiate cryptographic algorithms when
establishing unicast media streams involving Secure RTP/RTCP. The SBC 5x00
includes the crypto suites and optional session parameters in one or more crypto
attributes (a=crypto) of SDP offers and answers. Each crypto attribute describes a
cryptographic suite, key parameters, and any optional session parameters. The
most preferred crypto suite is listed first.
A SIP call signals and negotiates cryptographic parameters for the media stream
via the SDP m= line Crypto attribute. These parameters are mostly grouped into a
"crypto-suite" field that describes the encryption and authentication algorithms for
transport. The SBC 5x00 supports the crypto-suite "aes-cm-128 hmac-sha180." Secure RTP is requested by the presence of RTP/SAVP or RTP/SAVPF in
the m= line.
The appropriate crypto suite profile may also include valid combinations of the
following session parameters:
•
•
•
unauthenticatedSRTP -Signals that the SRTP packet payloads are not
authenticated.
unencryptedSRTP - Signals that the SRTP packet payloads are not
encrypted.
unencryptedSRTCP - Signals that the SRTCP packet payloads are not
encrypted.
By default, SRTP and SRTCP packet payloads are both authenticated and
encrypted. The SRTP specification requires the use of message authentication for
SRTCP, but not for SRTP. Use of unauthenticatedSRTP is not recommended.
Command Syntax
% set profiles security cryptoSuiteProfile
<cryptoSuiteProfile>
entry <entry>
cryptoSuite <cryptoSuite>
sessionParameterFlags <sessionParameterFlags>
6–96
Security
Profiles
% show profiles security cryptoSuiteProfile
% delete profiles security cryptoSuiteProfile
Command Parameters
TABLE 6–13 Crypto Suite Profile Parameters
Parameter
Field
Length
cryptoSuiteP 1-23
rofile
Description
Specifies the name of the Crypto Suite Profile. Must be 1-23
characters.
entry
N/A
Specifies the priority of the entry. The default value '1'.
cryptoSuite
N/A
Specifies a prioritized list of supported crypto suites that
the SBC 5x00 uses in one or more crypto attributes
(a=crypto) of SDP offers and answers when negotiating
Secure RTP calls using this profile.
• AES-CM-128-HMAC-SHA1-80 - Add the aes-cm-128-hmacsha1-80 crypto suite to this profile.
• none
sessionParame N/A
terFlags
displaylevel
Specifies the session parameter flags.
• unauthenticatedSRTP - signals that the SRTP packet
payloads are not authenticated. Options are: disable
enable.
• unencryptedSRTCP - signals that the SRTCP packet
payloads are not encrypted. Options are: disable
enable.
• unencryptedSRTP - signals that the SRTP packet payloads
are not encrypted. Options are: disable enable.
1-64
commands.
Command Example
% show profiles security cryptoSuiteProfile
cryptoSuiteProfileTest
entry 1
6–97
Profiles
Security
{
cryptoSuite AES-CM-128-HMAC-SHA1-80;
sessionParameterFlags
{
unencryptedSRTCP
enable;
unencryptedSRTP
enable;
unauthenticatedSRTP enable;
}
}
Key Management Protection Profile
This object establishes the encryption algorithm, the maximum SA lifetime, and
other SA conditions, for the peer. These properties are linked to each IKE peer
that is provisioned with this profile.
Command Syntax
set profiles security ikeProtectionProfile
<ikeProtectionProfile>
algorithms <algorithms>
dpdInterval <dpdInterval>
saLifetimeTime <saLifetimeTime>
show profiles security ikeProtectionProfile
algorithms <algorithms>
dpdInterval <dpdInterval>
delete profiles security ikeProtectionProfile
6–98
Security
Profiles
Command Parameters
TABLE 6–14 Key Management Protection Profile Parameters
Parameter
Field
Length
ikeProtection 1-23
Profile
algorithms
N/A
Description
The name of the Key Management Protection Profile. This
profile establishes the encryption algorithm, the maximum SA
lifetime, and the replay rules for an SPD entry. These
properties are used by the SBC 5x00 when it forms an IPSec
association with a peer.
Specifies the IPSec Protection Profile ESP protocol cipher
configurations.
• encryption - The IPsec Protection Profile Encryption
Cipher. You can select multiple encryptions. Options are:
- 3DesCbc
- aesCbc128
• integrity - The IPsec Protection Profile integrity Cipher.
You can select multiple parameters. Options are:
- hmacMd5
- hmacSha1
N/A
Specifies the IKE Protection Profile Dead Peer Detection test
interval period in seconds. The value '0' corresponds to DPD
disabled.
saLifetimeTim N/A
e
Specifies the IPSec Protection Profile SA Lifetime setting in
seconds. Must be 1200-1,000,000 seconds; the default value
is 28,800 seconds which corresponds to 8 hours.
dpdInterval
displaylevel
1-64
commands.
Command Example
% show profiles security ikeProtectionProfile
ikeProtectionProfile Test
{
saLifetimeTime 28800;
algorithms {
encryption 3DesCbc,aesCbc128;
integrity
dpdInterval
hmacSha1,hmacMd5;
45;
}
6–99
Profiles
Security
}
IPSec Profile
This profile specify an encryption cipher, a maximum time period for maintaining a
security association between these peers (the SA "lifetime"), and an anti-replay
policy. The three profiles are prioritized from one to three for usage with the SPD
entry.
Command Syntax
% set profiles security ipsecProtectionProfile
<ipsecProtectionProfile>
espAlgorithms <espAlgorithms>
saLifetimeByte <saLifetimeByte>
% show profiles security ipsecProtectionProfile
espAlgorithms <espAlgorithms>
saLifetimeByte <saLifetimeByte>
% delete profiles security ipsecProtectionProfile
6–100
Security
Profiles
Command Parameters
TABLE 6–15 IPSec Profile Parameters
Parameter
Field
Length
Description
ipsecProtect 1-23
ionProfile
The name of the IPSec Protection Profile. This profile
establishes the encryption algorithm, the maximum SA
lifetime, and the replay rules for an SPD entry. These
properties are used by the SBC 5x00 when it forms an IPSec
Security Association with a peer.
espAlgorithm N/A
s
Specifies the IPSec Protection Profile ESP protocol cipher
configurations. Options are:
• encryption - The IPsec Protection Profile Encryption
Cipher. You can select multiple encryptions. Options are:
- 3DesCbc
- aesCbc128
- null
• integrity - The IPsec Protection Profile integrity Cipher.
You can select multiple parameters. Options are:
- hmacMd5
- hmacSha1
saLifetimeBy N/A
te
Specifies the IPSec Protection Profile SA Lifetime setting in
number of bytes. The default value is "unlimited" or enter
value in range of (1000..4, 294, 967, 295 ) number of
bytes.
saLifetimeTi N/A
me
The SA Lifetime setting, in seconds. This is the maximum
interval that any one Security Association will be
maintained before possible re-keying. Must be 12001,000,000, default is 28,800 (seconds). This parameter
applies to the IKE SA when it appears in the IKE Protection
Profile and to the IPSec SA when it appears in the IPsec
Protection Profile. The default value corresponds to 8
hours.
displaylevel
1-64
commands.
Command Example
% show profiles security ipsecProtectionProfile
AesSha1IpsecProfile
{
saLifetimeTime 28800;
6–101
Profiles
Security
saLifetimeByte unlimited;
espAlgorithms
{
encryption null,3DesCbc,aesCbc128;
integrity
hmacSha1;
}
}
TLS Profile
This object creates and configures a profile for implementing the Transport Layer
Security (TLS) protocol for use with SIP over TLS. TLS is an IETF protocol for
securing communications across an untrusted network. Normally, SIP packets
goes in plain text over TCP or UDP connections; Secure SIP is a security
measure that uses TLS, the successor to the Secure Sockets Layer (SSL)
protocol.
To add a TLS protection-level policy, you create a tlsProfile and configure
each of the parameters. The tlsProfile is associated with sipSignalingPort.
The settings within the defaulttlsProfile may be modified. Also, the
supported transport protocols must be set to allow SIP over TLS.
Command Syntax
% set profiles security tlsProfile <tlsProfileName>
allowedRoles <allowedRoles>
appAuthTimer <appAuthTimer>
authClient <authClient>
cipherSuite1 <cipherSuite>
clientCertName <clientCertName>
handshakeTimer <handshakeTimer>
serverCertName <serverCertName>
sessionResumpTimer <sessionResumpTimer>
% show profiles security tlsProfile <tlsProfileName>
% show
profiles security tlsProfile <tlsProfileName>
allowedRoles <allowedRoles>
appAuthTimer <appAuthTimer>
6–102
Security
Profiles
authClient <authClient>
clientCertName <clientCertName>
handshakeTimer <handshakeTimer>
serverCertName <serverCertName>
sessionResumpTimer <sessionResumpTimer>
% delete
profiles security tlsProfile <tlsProfileName>
Command Parameters
TABLE 6–16 TLS Profile Parameters
Parameter
Field
Length
Description
tlsProfileNa 1-23
me
Specifies the name assigned to this Transport Layer Security
(TLS) profile. Must be 1-23 characters.
allowedRoles N/A
Specifies the allowed TLS roles for this TLS profile:
• client and server - The SBC 5x00 can be both TLS
client and TLS server, depending on the request direction.
This is primarily for peering applications.
• server - The SBC 5x00 will only be a TLS server. This is
primarily for access applications.
appAuthTimer N/A
Specifies the higher layer authentication timer in seconds.
Must be 1-60 seconds. The default value is 5.
N/A
Indicates whether or not a TLS client is forced to
authenticate itself within TLS. If set to false, the client is not
required to authenticate itself at the TLS layer but must
complete authentication within a higher-level protocol after
the TLS connection is established (that is, SIP
registration). The possible values are:
authClient
• false
• true
cipherSuite1 N/A
-3
Specifies the TLS cipher suite choice of this TLS profile.
The possible values are:
•
•
•
•
nosuite
rsa-with-3des-ede-cbc-sha
rsa-with-aes-128-cbc-sha
rsa-with-null-sha
6–103
Profiles
Security
TABLE 6–16 TLS Profile Parameters (Continued)
Parameter
Field
Length
Description
clientCertNa 1-23
me
Specifies the name of the default Client Certificate to be
used by this TLS profile, created using the SECURITY PKI
configuration object. Must be 1-23 characters or none.
handshakeTim N/A
er
Specifies the time in which the TLS handshake must be
completed. The timer starts when the TCP connection is
established. Must be 1-60 seconds. The default value is 5.
serverCertNa N/A
me
Specifies the name of the Server Certificate to be used by
this TLS profile, created using the SECURITY PKI
configuration object. Must be 1-23 characters or none.
sessionResum N/A
pTimer
Specifies the TLS session resumption period for which
cached sessions are retained (in seconds). TLS allows
successive connections to be created within one TLS
session and the resumption of a session after a TLS
connection is closed or after a server card failover, without
repeating the entire authentication and other setup steps
for each connection, except when the space must be
reclaimed for a new session. Must be 0-86,400 seconds;
default is 3600.
displaylevel
1-64
commands.
Command Example
% show profiles security tlsProfile TestingTLS
appAuthTimer
5;
handshakeTimer
5;
sessionResumpTimer 3590;
6–104
cipherSuite1
rsa-with-aes-128-cbc-sha;
cipherSuite2
rsa-with-null-sha;
cipherSuite3
rsa-with-3des-ede-cbc-sha;
allowedRoles
server;
authClient
true;
clientCertName
TestigTP;
serverCertName
test23;
Services
Profiles
Services
The Services object supports the following profiles:
•
•
•
Class Of Service
Emergency Call Profile
SIP ARS Profile
Class of Service
The Class of Service (CoS) can be provisioned for various call processing entities
and it includes many services currently supported on the SBC 5x00. Use the
Class of Service object to provision services that are common and shared among
your SBC 5x00 call processing entities.
Many of the parameters in the Class of Service profile allow you to select a script.
The SBC 5x00 is shipped with a number of pre-defined scripts. You can also use
the Sonus Service Profile Editor (SPE) to provision additional scripts, which you
can then select in Class of Service profiles.
Command Syntax
% set profiles services classOfService <classOfService>
blocking
entry <entry>
service <service>
// Mandatory parameters
blocking entry <entry>
calledNumber
country
callType
nonSubscriberCallTypeFiltering
<nonSubscriberCallTypeFiltering>
screening <script>
% show profiles services classOfService <classOfService>
6–105
Profiles
Services
entry <entry>
service <service>
<nonSubscriberCallTypeFiltering>
screening
script <script>
% delete profiles services classOfService <classOfService>
Command Parameters
TABLE 6–17 Class of Service Parameters
Parameter
Field
Length
classOfServi N/A
ce
Description
A unique identifier for Class Of Service.
blocking
N/A
Specifies to enable the blocking service.
entry
N/A
Specifies blocking service for the called number.
service
N/A
Specified service is executed only if the service flag is
enabled.
• disable
• enable
6–106
Services
Profiles
TABLE 6–17 Class of Service Parameters (Continued)
Parameter
Field
Length
Description
nonSubscribe N/A
rCallTypeFil
tering
script
The call types for which Non-Subscriber Call Routing is
available in this CoS.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
N/A
The Script to use with this blocking service.
•
•
•
•
•
•
displaylevel
carrierCutThrough
internationalType
ipVpnService
localOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
private
test
transit
userName
1-64
BLOCKING
DEFAULT_TERMINATING
NONSUB_DENY
NO_ROUTES_FOUND
SCREENING
TANDEM
commands.
Command Example
% show profiles services classOfService
classOfService DEFAULT_IP {
screening {
script "TANDEM";
}
blocking {
service enable;
entry 1 INDIA {
callType mobile;
}
}
6–107
Profiles
Services
private,nationalOperator,localOperator,nationalType,inter
nationalType,internationalOperator,longDistanceOperator,i
pVpnService,test,transit,otherCarrierChosen,carrierCutThr
ough,userName,mobile;
}
Emergency Call Profile
When emergency calls (for example, calls to 911) are received, the SBC 5x00
recognizes them and proceeds to route them directly without any check for
provisioned services. For proper routing to occur, an emergency routing label,
emergency routes, and an emergency standard route entity must be provisioned.
Command Syntax
// Mandatory parameters to configure an Emergency call profile
% set profiles services emergencyCallProfile
<emergencyCallProfile>
cpc <cpc>
prefix1 <prefix1>
prefix2 <prefix2>
prefix3 <prefix3>
% show profiles services emergencyCallProfile
cpc <cpc>
prefix1 <prefix1>
prefix2 <prefix2>
prefix3 <prefix3>
6–108
Services
Profiles
% delete profiles services emergencyCallProfile
Command Parameters
TABLE 6–18 Emergency Call Profile Parameters
Parameter
Field
Length
emergencyCal 1-23
lProfile
N/A
cpc
Description
Specifies the emergency call profile name.
This parameter controls the SBC 5x00 behavior of whether
SIP cpc=priority can be used for emergency call indication
or not.
• none
• priority
prefix1
N/A
Alphanumeric string emergency prefix #1. An incoming call
will be classified as an emergency call if the called number
matches this prefix.
prefix2
N/A
prefix3
displaylevel
1-64
commands.
Command Example
emergencyCallProfile Test12 {
prefix1 P1;
prefix2 P2;
prefix3 P3;
cpc
priority;
}
6–109
Profiles
Services
SIP ARS Profile
To achieve efficient device failover to the backup/secondary Application Server,
the SBC 5x00 uses the Address Reachability Service (ARS) to determine if a
server is reachable, providing the ability to “blacklist” a server IP address if it is
found to be unreachable, as well as the ability to remove the server from the
blacklisted state. ARS profiles can be created to configure variants of blacklisting
and recovery algorithms. These ARS profiles can be assigned to Service groups
to enforce the blacklisting and recovery of the servers in the service group.
Command Syntax
% set profiles services sipArsProfile <sipArsProfile>
blkListAlgRetryAfterType <blkListAlgRetryAfterType>
blkListAlgTimeoutsDuration <blkListAlgTimeoutsDuration>
blkListAlgTimeoutsNumTimeouts
<blkListAlgTimeoutsNumTimeouts>
blkListAlgTimeoutsType <blkListAlgTimeoutsType>
blkListAlgorithms <blkListAlgorithms>
recoveryAlgProbeDuration <recoveryAlgProbeDuration>
recoveryAlgProbeInterval <recoveryAlgProbeInterval
recoveryAlgProbeMethod <recoveryAlgProbeMethod
recoveryAlgProbeNumResponses <recoveryAlgProbeNumResponses>
recoveryAlgTimerDuration <recoveryAlgTimerDuration
recoveryAlgorithm <recoveryAlgorithm>
state <state>
% show profiles services sipArsProfile <sipArsProfile>
blkListAlgRetryAfterType <blkListAlgRetryAfterType>
blkListAlgTimeoutsDuration <blkListAlgTimeoutsDuration>
6–110
Services
Profiles
blkListAlgTimeoutsNumTimeouts
<blkListAlgTimeoutsNumTimeouts>
blkListAlgTimeoutsType <blkListAlgTimeoutsType>
blkListAlgorithms <blkListAlgorithms>
recoveryAlgProbeDuration <recoveryAlgProbeDuration>
recoveryAlgProbeInterval <recoveryAlgProbeInterval
recoveryAlgProbeMethod <recoveryAlgProbeMethod
recoveryAlgProbeNumResponses <recoveryAlgProbeNumResponses>
recoveryAlgTimerDuration <recoveryAlgTimerDuration
recoveryAlgorithm <recoveryAlgorithm>
state <state>
6–111
Profiles
Services
% delete profiles services sipArsProfile <sipArsProfile>
Command Parameters
TABLE 6–19 SIP ARS Profile Parameters
Parameter
Field
Length
Description
sipArsProfil 1-23
e
Specifies the name of the SIP Address Reachability Service
profile. Must be 1-23 characters.
blkListAlgRe N/A
tryAfterType
When the BLACKLISTING ALGORITHM type is retry after,
specifies the trigger for that type:
• sip-503 - When a sip-503 message is received with RetryAfter field from a downstream server, put that server into
blacklist. This prevents new call requests (SIP INVITEs) from
being retransmitted and starts a Recovery Algorithm to
recover the server from blacklist after a defined duration.
blkListAlgTim N/A
eoutsDuration
Specifies the duration (in seconds) in which the specified
number of timeouts must occur. Must be 1-3600; default
value is 1.
blkListAlgTim N/A
eoutsNumTimeo
uts
Specifies the number of timeout events that must occur
before black listing the address. Must be 1-3600; default
value is 1.
blkListAlgTim N/A
eoutsType
Specifies the timeout trigger:
blkListAlgori N/A
thms
• sip-invite - use SIP INVITE messages as a timeout
trigger.
Indicates which blacklisting algorithms should be used for
this Address Reachability Service Profile. The possible
blacklisting algorithms are:
• retryafter - use the blkListAlgRetryAfterType (trigger) as
the blacklisting criteria.
• timeouts - The timeout of the specified SIP message will
be used for blacklisting the server. The algorithm TYPE,
NUMBER OF TIMEOUTS, and DURATION attributes for this
parameter must also be specified.
recoveryAlgPr N/A
obeDuration
Specifies the duration (in seconds) in which the specified
number of responses must occur. Must be 1-3600; default
value is 1.
recoveryAlgPr N/A
obeInterval
Specifies the probe interval value. Must be 1-600; default
value is 1.
6–112
Services
Profiles
TABLE 6–19 SIP ARS Profile Parameters (Continued)
Parameter
Field
Length
recoveryAlgPr N/A
obeMethod
Description
Specifies the probe method. The possible value is:
• sip-options
recoveryAlgPr N/A
obeNumRespons
es
Specifies the number of responses that must occur before
removing an entry from the black list. Must be 1-32; default
value is 1.
recoveryAlgTi N/A
merDuration
Specifies the duration (in seconds) for which the IP
address will remain black listed. Must be 1-3600; default
value is 1.
recoveryAlgor N/A
ithm
Specifies the recovery algorithm. The possible values are:
N/A
state
• probe - the ARS initiates an active “ping” to the blacklisted
server until it gets a response. Once a response is received,
the address is removed from the blacklist.
• timer - the ARS removes the entry for the blacklist after a
configured duration.
Specifies the admin state of this SIP Address Reachability
Service Profile.
• disabled
• enabled
displaylevel
1-64
commands.
Command Example
% show profiles services sipArsProfile
sipArsProfile Test12 {
state
enabled;
blkListAlgorithms
timeouts,retryafter;
blkListAlgTimeoutsType
sip-invite;
blkListAlgTimeoutsNumTimeouts 45;
blkListAlgTimeoutsDuration
34;
blkListAlgRetryAfterType
sip-503;
recoveryAlgorithm
probe;
recoveryAlgTimerDuration
456;
recoveryAlgProbeMethod
sip-options;
recoveryAlgProbeInterval
78;
recoveryAlgProbeNumResponses
6;
recoveryAlgProbeDuration
546;
}
6–113
Profiles
6–114
Services
Signaling
Profiles
Signaling
This object is used to configure parameters associated with H323, SIP and IP
signaling communication that are sent as part of the outgoing signaling message
after standard protocol rules have been applied.
Signaling supports the following profiles which are explained in the sections
below:
•
•
•
•
•
"IP Signaling Profile" on page 6–115
"ISUP Signaling Profile" on page 6–157
"Number Globalization Profile" on page 6–166
"SIP Adaptor Profile" on page 6–171
"SIP/CPC Cause Code Mapping Profile" on page 6–181
IP Signaling Profile
This object allows you to configure the following IP signaling profiles:
•
•
H323
SIP
Following sub sections provides command syntax and parameter description.
H323 Profile
This object allows you to configure the following H323 signaling profiles:
•
•
•
•
Common IP attributes
egressIpAttributes
ingressIpAttributes
ipProtocolType
This section lists CLI commands of common IP attributes for communicating with
the peer regardless of call direction.
Command Syntax
% set profiles signaling ipSignalingProfile DEFAULT_H323
commonIpAttributes flags
audioCodecChangeThroughEmptyTcs <enable | disable>
disableConstrainedCapacities <enable | disable>
includeG729WithG729aWhenOfferPspHasG729a <enable | disable>
sendEmptyTcs <enable | disable>
6–115
Profiles
Signaling
% show profiles signaling ipSignalingProfile DEFAULT_H323
commonIpAttributes
commonIpAttributes flags <flags>
% delete profiles signaling ipSignalingProfile DEFAULT_H323
commonIpAttributes flags <flags>
Command Parameters
TABLE 6–20 IP Signaling Profile H323 Common IP Attributes
Parameter
Field
Length
audioCodecCh N/A
angeThroughE
mptyTcs
Description
Specifies the audio codec change through empty TCS flag.
• disable - Disables the audio codec change.
• enable - Enables the audio codec change.
disableConst N/A
rainedCapaci
ties
Specifies the Disable Constrained Capacities flag.
includeG729W N/A
ithG729aWhen
OfferPspHasG
729a
Controls whether the H323 Service Group on SBC 5x00
includes G729 along with G729A in the network offer when
the SBC 5x00 offer Packet Service Profile has G729A.
sendEmptyTcs N/A
• disable - Disables the Disable Constrained Capacity flag.
• enable - Enables the Disable Constrained Capacity flag.
• disable - G729 is not included with G729A in the offer to the
peer.
• enable - G729 is included with G729A in the offer to the peer.
Specifies the SBC 5x00 to send an Empty TCS to a peer.
Options are:
• disable - SBC 5x00 does not sends an empty TCS to the
peer.
• enable - SBC 5x00 sends an empty TCS to the peer, which
can restart the peer’s forward channel in case there is an
address update in the direct media case.
displaylevel
1-64
commands.
Command Example
6–116
Signaling
Profiles
ipProtocolType h323;
commonIpAttributes {
flags {
audioCodecChangeThroughEmptyTcs
disable;
disableConstrainedCapacities
disable;
includeG729WithG729aWhenOfferPspHasG729a
disable;
sendEmptyTcs
disable;
}
}
Egress IP attributes
This section lists CLI commands of H323 egress IP attributes for sending a call in
the forward direction to the peer.
Command Syntax
egressIpAttributes
bci <bci>
flags <flags>
numberGlobalizationProfile <numberGlobalizationProfile>
egressIpAttributes
bci <bci>
flags <flags>
egressIpAttributes
bci <bci>
flags <flags>
6–117
Profiles
Signaling
Command Parameters
TABLE 6–21 IP Signaling Profile H323 egress Attributes
Parameter
Field
Length
Description
bci
N/A
Specifies the bci flag.
• bciInterworkEncountered - Enables or disables the BCI
Interwork Encountered Flag. SBC 5x00 sets the Interworking
Indicator bit in the BCI parameter of backward SS7 messages
(e.g., ACM or ANM).
• bciIsdnAddess - Enables or disables BCI ISDN Address
Flag. SBC 5x00 sets the ISDN Access Indicator bit in the BCI
parameter of backward SS7 messages (e.g., ACM or ANM).
N/A
flags
Specifies the flags for egress IP attributes.
• delayCutThrough - Enables or disables the Delay Cut
Through Flag.
• dontSendFastStartProposal - Enables or disables the
Don't Send Fast Start Proposal Flag.
• insertInBandIndication - When this flag is enabled, on
receipt of an H.225 ALERT message, the egress H.323
signaling gateway on the SBC 5x00 will insert an in-band
indication in the ALERT message in backward direction.
• waitTillConnectBeforeAbandonFastStart - When
this flag is enabled, the SBC 5x00 honors the procedures
defined in H.323 V4 for switching to H.245. The SBC 5x00 will
abandon FastStart procedures if an H.323 Connect message
is received, a FastConnectRefused message is received, or
an H.245 address is received.
numberGlobal N/A
izationProfi
le
displaylevel
1-64
Specifies the Number Globalize Profile. This profile
converts numbers to SIP global number format. The
default value is <none>.
commands.
Ingress IP attributes
This section lists CLI commands of ingress IP attributes.
Command Syntax
ingressIpAttributes flags
convertProgressToAlert <convertProgressToAlert>
dontSendFacilityMessage <dontSendFacilityMessage>
refuseFastStartProposal <refuseFastStartProposal>
sendFastStartResponseInCp <sendFastStartResponseInCp>
6–118
Signaling
Profiles
ingressIpAttributes
flags <flags>
ingressIpAttributes flags
Command Parameters
TABLE 6–22 IP Signaling Profile Ingress Attributes
Parameter
Field
Length
convertProgr N/A
essToAlert
dontSendFaci N/A
lityMessage
refuseFastSt N/A
artProposal
sendFastStar N/A
tResponseInC
p
Description
Specifies the Convert Progress To Alert Flag. Options are:
• disable - Does not convert progress messages into Alerting
messages.
• enable - Converts Progress messages into Alerting
messages, used for interworking with endpoints that have
difficulties with Progress messages
Specifies the Don't Send Facility Message flag.
• disable - Does not convert progress messages into Alerting
messages.
• enable - Does not send Facility messages, used for
endpoints that do not tunnel and have difficulties with Facility
messages.
Specifies the Refuse Fast Start Proposal flag.
• disable - Disables the Refuse Fast Start Proposal flag.
• enable - Enables the Refuse Fast Start Proposal flag.
When this parameters is used, the SBC 5x00 sends a
FastStart response message in Call Proceeding
messages.
• disable - Does not send a FastStart response message in
Call Proceeding messages.
• enable - Sends a FastStart response message in Call
Proceeding messages.
displaylevel
1-64
commands.
6–119
Profiles
Signaling
IP Protocol Type Attributes
This section lists CLI commands of IP protocol type attributes.
Command Syntax
ipProtocolType <ipProtocolType> commonIpAttributes flags
audioCodecChangeThroughEmptyTcs <enable | disable>
disableConstrainedCapacities <enable | disable>
includeG729WithG729aWhenOfferPspHasG729a
<includeG729WithG729aWhenOfferPspHasG729a>
sendEmptyTcs <sendEmptyTcs>
ipProtocolType <ipProtocolType> egressIpAttributes flags
delayCutThrough <delayCutThrough>
dontSendFastStartProposal <dontSendFastStartProposal>
insertInBandIndication <insertInBandIndication>
waitTillConnectBeforeAbandonFastStart
<waitTillConnectBeforeAbandonFastStart>
ipProtocolType <ipProtocolType> ingressIpAttributes
flags
ipProtocolType <ipProtocolType>
6–120
Signaling
Profiles
Command Parameters
TABLE 6–23 IP Signaling Profile H323 IP Protocol Type
Parameter
Field
Length
ipProtocolTy N/A
pe
audioCodecCh N/A
angeThroughE
mptyTcs
Description
Specifies the IP protocol type. Options are:
• h323
• sipI
• sipOnly
Specifies the audio codec change through empty TCS flag.
• disable - Disables the audio codec change.
• enable - Enables the audio codec change.
disableConst N/A
rainedCapaci
ties
Specifies the Disable Constrained Capacities flag.
includeG729W N/A
ithG729aWhen
OfferPspHasG
729a
Controls whether the H323 Service Group on SBC 5x00
includes G729 along with G729A in the network offer when
the SBC 5x00 offer Packet Service Profile has G729A.
sendEmptyTcs N/A
• disable - Disables the Disable Constrained Capacity flag.
• enable - Enables the Disable Constrained Capacity flag
• disable - G729 is not included with G729A in the offer to the
peer.
• enable - G729 is included with G729A in the offer to the peer.
Specifies the SBC 5x00 to send an Empty TCS to a peer.
Options are:
• disable - SBC 5x00 does not sends an empty TCS to the
peer.
• enable - SBC 5x00 sends an empty TCS to the peer, which
can restart the peer’s forward channel in case there is an
address update in the direct media case.
delayCutThro N/A
ugh
When this flag is enabled, the SBC issues call cut through
until egress media setup is complete (through fast start or
H.245 procedure). When this flag is disabled (default),
SBC issues call cut through as soon as the egress peer
indicates in band tone is available through progress
indicators independent of the availability of media
information from the egress peer.
• disable
• enable
dontSendFast N/A
StartProposa
l
When this flag is enabled, SBC does not include fast start
proposal in early media calls. It relies on H.245 procedure
to complete media setup. When this flag is disabled
(default), SBC always include fast start proposal in SETUP
message for an early media calls.
• disable
• enable
6–121
Profiles
Signaling
TABLE 6–23 IP Signaling Profile H323 IP Protocol Type
Parameter
Field
Length
insertInBand N/A
Indication
Description
When this flag is enabled, on receipt of an H.225 ALERT
message, the egress H.323 signaling gateway on the SBC
5x00 will insert an in-band indication in the ALERT
message in backward direction (toward the PSTN).
• disable
• enable
waitTillConn N/A
ectBeforeAba
ndonFastStar
t
When this flag is enabled, the SBC 5x00 honors the
procedures defined in H.323 V4 for switching to H.245. The
SBC 5x00 will abandon FastStart procedures if an H.323
Connect message is received, a FastConnectRefused
message is received, or an H.245 address is received.
• disable
• enable
convertProgr N/A
essToAlert
When this flag is enabled, the SBC 5x00 converts Progress
messages into Alerting messages, used for interworking
with endpoints that have difficulties with Progress
messages.
• disable
• enable
dontSendFaci N/A
lityMessage
When this flag is enabled, the SBC 5x00 does not send
Facility messages, used for endpoints that do not tunnel
and have difficulties with Facility messages.
• disable
• enable
refuseFastSt N/A
artProposal
When this flag is enabled, SBC refuses the fast start
proposal of incoming calls. It relies on the H.245 procedure
to complete media setup. When this this flag is disabled
(default), SBC always performs media
setup through fast start procedure.
• disable
• enable
sendFastStar N/A
tResponseInC
p
displaylevel
1-64
When this flag is enabled, the SBC 5x00 sends a FastStart
response message in Call Proceeding messages.
• disable
• enable
commands.
SIP Profile
This object allows you to configure the following SIP signaling profiles:
6–122
Signaling
•
•
•
•
Profiles
egressIpAttributes
ingressIpAttributes
ipProtocolType
This section lists CLI commands of common IP attributes for communicating with
the peer regardless of call direction.
Command Syntax
% set profiles signaling ipSignalingProfile DEFAULT_SIP
commonIpAttributes
callTransferFlags <callTransferFlags>
flags <flags>
optionTagInRequireHeader <optionTagInRequireHeader>
optionTagInSupportedHeader <optionTagInSupportedHeader>
relayFlags <relayFlags>
transparencyFlags <transparencyFlags>
% show profiles signaling ipSignalingProfile DEFAULT_SIP
commonIpAttributes
callTransferFlags <callTransferFlags>
flags <flags>
optionTagInRequireHeader <optionTagInRequireHeader>
optionTagInSupportedHeader <optionTagInSupportedHeader>
relayFlags <relayFlags>
transparencyFlags <transparencyFlags>
6–123
Profiles
Signaling
Command Parameters
TABLE 6–24 IP Signaling Profile SIP Common IP Attributes
Parameter
Field
Length
callTransfer N/A
Flags
Description
Specifies transfer flags.
• forceReRouteViaPsxQuery - This flag is used by the SBC
5x00 to handle a transferred call. When the enabled the SBC
5x00 performs a PSX query for new routes instead of using
the IP address received in the Refer-To header. When
disabled, the SBC 5x00 does one of three things:
- If the IP address in the Refer-To header is zero or
matches the SBC 5x00 signaling IP address, the
SBC 5x00 performs a PSX query for new routes.
- If the IP address in the Refer-To header doesn’t
match the SBC 5x00 signaling IP address and it is
present in the SBC 5x00 Network Selector table, the
SBC 5x00 sends an INVITE message to the IPTG
selected from the Network Selector table.
- If the IP address in the Refer-To header doesn’t
match the SBC 5x00 signaling IP address and it is
not present in the SBC 5x00 Network Selector table,
the SBC 5x00 handles the transfer via the Handle IP
Addresses Not Present In Network Selector Table
field (see above).
• handleIpAddressesNotPresentInNetworkSelectorTab
leNst - Handle IP Addresses Not Present In Network
Selector Table NST. This field is used by the SBC 5x00 to
handle a transferred call when the SBC 5x00 does not perform
a PSX query for new routes and the IP address received in the
Refer-To header is not present in the SBC 5x00 Network
Selector table. Options are:
- rejectCall
- routeViaDefaultZoneIptg
- routeViaDefaultiptg
- routeViaTransferringIptg
6–124
Signaling
Profiles
Parameter
Field
Length
Description
flags
N/A
Specifies the flags.
callHoldInterworking - Controls Call Hold
Interworking service between ISUP and SIP. When
enabled, the SBC 5x00 has Call Hold Interworking. When
disabled, Call Hold Interworking is disabled.
The service converts an ISUP call hold to an SIP call hold,
or vice-versa. Call holds are invoked by ISUP or SIP/H.323
endpoints. When disabled, call hold indications are
dropped.
clearmodeForDataCalls - This parameter is used to
enable the clearmode function for data calls. When
enabled, the SBC 5x00 enables clearmode. When
disabled, the SBC 5x00 provides legacy G.711 behavior.
createPChargingVector - Controls whether a PCharging-Vector header is created in outgoing SIP
messages. When this parameter is enabled, the SBC 5x00
creates a new PCharging- Vector header in the outgoing
message. When disabled, the SBC 5x00 does not create a
new P-Charging-Vector header.
Creating P-Charging-Vector headers is supported in
INVITE and REGISTER messages. It is also supported in
SUBSCRIBE, OPTIONS, and NOTIFY messages when
received from the same direction as the REGISTER
message.
createPathHeader - Controls whether the SBC 5x00
creates a Path header in outgoing SIP REGISTER
messages. When enabled, the SBC 5x00 creates a new
Path header in the outgoing message. When disabled, the
SBC 5x00 does not create a new Path header.
createServiceRouteHeader - Controls whether the SBC
5x00 creates a Service-Route header in outgoing SIP
messages. When enabled, the SBC 5x00 creates a new
Service-Route header in the outgoing message. When
disabled, the SBC 5x00 does not create a new ServiceRoute header.
customizedSessionTimerBehavior - Specifies the
session timer behavior expected by the remote peer. When
enabled, the remote peer expects customer-specific
session timer behavior. When disabled, the remote peer
expects the standard session timer behavior.
disableAlsoHeader - Specifies whether to use the Also
header. When enabled, the SBC 5x00 ignores the Also
header if received from the remote peer and the SBC 5x00
does not send the Also header to the remote peer. When
disabled, the SBC 5x00 uses the Also header for call
forwarding as usual.
6–125
Profiles
Signaling
Parameter
Field
Length
flags
N/A
(continued.)
Description
disableHostTranslation - To enable/disable host name
translation is disabled. This applies to all URL style headers that
require transparency and defines the processing that SBC 5x00
is to apply to the host name portion of these headers before
forwarding.
disableMediaLockDown - Controls whether the SBC 5x00
disables media lock down. When enabled, the SBC 5x00
disables media lock down by not sending SIP Re-INVITE/
UPDATE messages. When the disabled, the SBC 5x00
enables media lock down by sending Re-INVITE/UPDATE
messages.
disableReferToUriParameters - By default, parameters
in the SIP URI Refer-To header are passed through to the
outgoing INVITE. When enabled, this function is disabled. When
disabled, the URI parameters are copied to the Refer To field in
the outgoing INVITE.
discardReceivedReasonHeader - Specifies whether to
use the cause code in the Reason header received from
the remote peer. When enabled, the SBC 5x00 ignores the
cause code in the received Reason header. When
disabled, the SBC 5x00 uses the cause code in the
received Reason header.
doNotIncludeSsAttributeInReInvite - Specifies
whether the SBC 5x00 sends silence suppression to the
remote peer. When enabled, the SBC 5x00 does not send
silence suppression (no a=silenceSupp is sent) in the SDP
to the remote peer. When disabled, and when silence
suppression is off, the SBC 5x00 sends a=silenceSupp:off
in the SDP to the remote peer. Note that a=silenceSupp:on
is never sent to the remote peer in the Sonus
implementation when silence suppression is on.
endToEndBye - Controls whether the SBC 5x00 will issue
an end-to-end BYE on the side initiating the disconnect,
depending on the receipt of a BYE from the other leg.
When enabled, for SIP-SIP calls the SBC 5x00 does not
issue the 200 BYE on the side initiating the disconnect until
the 200 BYE is received from the other leg. When disabled,
for SIP-SIP calls the SBC 5x00 issues the 200 BYE on the
side initiating the disconnect regardless of whether a 200
BYE is received from the other leg.
includeIpPortsInFromAndToHeaders - When enabled,
port numbers are included with IP addresses in the From
and To headers of SIP messages. When disabled, port
numbers are not included with IP addresses.
includeReasonHeader - When enabled, the SBC 5x00
includes the Reason header in 18x, 4xx, 5xx, Cancel, and
Bye messages in the forward direction. It is provisioned on
the egress trunk group.
6–126
Signaling
Profiles
Parameter
Field
Length
flags
N/A
(continued.)
Description
includeSsAttributeInInitialInvite - Specifies
whether the SBC 5x00 sends the SS attribute in the initial Invite
to the remote peer. When enabled, the a=silenceSupp:off is sent
in the Initial Invite SDP to the remote peer when Silence
Suppression is OFF. When disabled, a=silenceSupp is not sent
in the Initial Invite SDP to the remote peer. Note that
a=silenceSupp on is never sent to the remote peer in the Sonus
implementation when Silence Suppression is ON.
includeTransportTypeInContactHeader - Used by the
SBC 5x00 SIPE to control inclusion or exclusion of the
Transport Type parameter in the Contact headers of 3XX
responses. When the enabled, the SBC 5x00 SIPE includes
the Transport Type parameter in the Contact headers of 3XX
responses. When disabled, the SBC 5x00 SIPE does not
include the Transport Type parameter.
insertPeerAddressAsTopRouteHeader - When
enabled, the SBC 5x00 SIPE inserts the IP address of the
next hop in the top route header of the egress INVITE. This
is required when the SBC 5x00 is acting as a IMS BGCF
proxy. It is also used to support SIPconnect compliance for
direct inward dialing.
mapCauseLocation - When enabled, the cause location is
added to or retrieved from the SIP Reason header when
mapping ISUP–SIP or SIP– ISUP signaling. When
disabled, the cause location mapping is disabled. To
enable this function, the Include Reason Header function
must also be enabled. ISUP (and other protocols) indicate
where in the network a call release was initiated from; this
option enables the SIP Reason header to carry the cause
location as well as the cause value.
mapSuspendResumeEventInPSvcInfoHeader - Controls
whether the SBC 5x00 maps the suspend/resume event in
the P-Svc-Info header of SIP messages. When enabled,
the SBC 5x00 maps the suspend/resume event in the PSvc-Info header. When disabled, the SBC 5x00 does not
map the suspend/resume event in the P-Svc-Info header.
mapUuiInPSigInfoHeader - Specifies whether the SBC
5x00 maps the UUI parameter and includes it in the SIP PSig-Info header. When enabled, the SBC 5x00 maps and
includes the UUI parameter. When disabled, the SBC 5x00
does not map or include the UUI parameter.
mimeCausePrecedeReasonHeaderCause - When enabled,
the cause value is mapped from the MIME body of the
incoming message based on the Q.1912 standard. When
disabled, the cause value is mapped from the Reason
header based on the RFC3398 standard.
6–127
Profiles
Signaling
Parameter
Field
Length
flags
N/A
(continued.)
Description
minimizeRelayingOfMediaChangesFromOtherCallLegA
ll - This flag is used to minimize the relaying of media
changes to the other call leg on a Sonus SBC.
When enabled, the SBC 5x00 does not send re-INVITE
messages from SIP Server 1 to SIP Server 2 in peer-topeer passthrough without transcoding scenarios. This
allows the call leg to SIP Server 2 to be shielded from the
end-to-end propagation of SDP offers and answers. The
SBC 5x00 implements hold and resume operations for the
call leg from SIP Server 1 internally and responds with
answers without signaling to the other call leg that media is
being stopped or restarted.
When disabled, the SBC 5x00 does not minimize the
relaying of media changes.
NOTE
When this parameter is enabled
and a call is put on hold, SBC
5x00 detection of rogue media
may occur and the call may be
reported as a rogue media
offender. The UDP port
associated with the call may be
quarantined. If a Secure RTP call
is put on hold for approximately
five minutes, the audio is lost
when the call is taken off hold.
Use of this flag is discouraged. It
should be used with the
understanding of the drawbacks
described in this note.
noContentDisposition - Specifies the Content
Disposition header format in SIP messages expected by
the remote peer. When enabled, the remote peer expects
no Content Disposition header. When disabled, the remote
peer expects the standard SIP message format, which
includes the Content Disposition header.
noPortNumber5060 - This parameter is used by the SBC
5x00 to control whether port number 5060 is sent to the
remote peer in the Request-URI of PRACK, ACK, and BYE
messages.
6–128
When enabled, the outgoing SIP URI does not include the
port number 5060 (sip:user@host). In addition, the SBC
5x00 only sends out the Record-Route and Route headers
of SIP request and response messages with the port
number it receives, such that if the SBC 5x00 does not
550-05337 headers,
— Version 0.3
— Release
receive a port number in Record-Route
the
SBC V03.00.00
5x00 does not send out a port number in the Record-Route
and Route headers.
When disabled, the outgoing SIP URI includes the port
Signaling
Profiles
Parameter
Field
Length
flags
N/A
(continued.)
Description
noUserinfoInContactHeader - Specifies the Contact
header format in SIP messages expected by the remote
peer. When enabled, the remote peer expects no userinfo
component in the Contact header URI. When disabled, the
remote peer expects the standard format of the Contact
header, which includes the userinfo component.
onlySelectedCodecInSessionRefresh - When enabled,
the SDP in a session keep-alive re-INVITE message will
only include the currently selected codecs for the call. The
o-line of the SDP will be identical to that in the last offer.
When disabled, the SDP in a session keep-alive reINVITE message will be identical to that in the last offer.
pChgMsgInfo - When enabled, the SBC 5x00 adds a P-
ChgMsg header to a SIP INFO or a 183 Session Progress
(which it selects depends on the call state). The P-ChgMsg
header contains the interworked ISUP CHG with TLEC
information. When disabled, this function is disabled.
reQueryPsxOnRegisterRefresh - When enabled, the
SBC 5x00 will re-query the SBC 5x00 when it receives a
register refresh message, which may result in a new or
updated result for the register relay. When disabled, the
SBC 5x00 does not re-query the SBC 5x00 on a register
refresh.
This setting must be made on the ingress trunk group
profile facing the registered endpoint.
rejectRefer - When enabled, the SBC 5x00 rejects SIP
REFER messages from the peer and responds with a 405
Method Not Allowed message.
replaceHostOnViaHeader - This flag will replace the IP
address of the top most via header on the outgoing request with
IP address or hostname present in the top most via header
received. Options are:
- enabled - Replace the IP address of via header on the
initial outbound INVITE or REGISTER with the address
received in the via header of the incoming request.
- disabled - When disabled, the SBC 5x00 defaults to
B2BUA behavior where the VIA header contains the local
SIP signaling address.
sdpOlineOnlyCompares - When enabled, the SBC 5x00
checks only the o-line when comparing SDPs.
When disabled, the SBC 5x00 checks the entire SDP body
when comparing SDPs.
sendAllAllowedCodecsForLateMediaInviteOrReInvit
e - When enabled, the SBC 5x00 sends all allowed codecs
in the Offer SDP to a late media Invite or Re-Invite. When
disabled, the SBC 5x00 sends the codec selected in the
Offer SDP to a late media Invite or Re-Invite.
6–129
Profiles
Signaling
Parameter
Field
Length
flags
N/A
(continued.)
Description
sendDirectMediaInfoInSdpAttribute -Used by the
SBC 5x00 to enable encoding direct media information in
signaling. When enabled, the SBC 5x00 sends direct
media information in the SDP attribute X-dmi. When
disabled, the SBC 5x00 does not send direct media
information.
sendPtimeInSdp - When enabled, the SBC 5x00 sends
a=ptime in the SDP.
When disabled, the SBC 5x00 does not send a=ptime in
the SDP.
sessionTimerRefreshUpdate - This flag controls the
session timer refresh method with SIP peers.
When enabled, the SBC 5x00 sends UPDATE messages.
When disabled, the SBC 5x00 resends INVITE messages.
setAcceptHeaderToApplicationSdpOnly - Specifies the
Accept header format in SIP messages expected by the
remote peer. When enabled, the remote peer expects a
short Accept header format that contains the application/
SDP value only. When disabled, the remote peer expects
the standard Accept header format containing all of the
standard parameters.
setOlineDash - Specifies the SDP O-Line format in the
SDP of SIP messages expected by the remote peer. When
enabled, the remote peer expects an O-Line format in
which the username component is set to a “-” (dash).
When disabled, the remote peer expects the standard OLine format containing all of the O-Line parameters,
including the username.
setSessionVersionZero - Controls the session version in
the outbound SDP. When enabled, the SBC 5x00 sets the
session version to zero in the o-line of the outbound SDP.
When disabled, the SBC 5x00 assigns a session version
randomly.
setSlineDash - Specifies the SDP S-Line format in the
SDP of SIP messages expected by the remote peer. When
enabled, the remote peer expects a short S-Line format
that contains a dash only (s=-). When disabled, the remote
peer expects the standard S-Line format containing all of
the S-Line parameters.
skipPsxQueryForRefer - Skips the PSX query for
Refer flag.
storePathHeader- Controls whether a Path header
6–130
received in an incoming SIP message should be stored/
cached locally on the SBC. When enabled, the received
Path header is stored. When disabled, the received Path
header is not stored.
Signaling
Profiles
Parameter
Field
Length
flags
N/A
(continued.)
Description
storeServiceRouteHeader - Controls whether a ServiceRoute header received in a 200-class response to a
REGISTER request should be stored/cached locally on the
SBC. When enabled, the received Service-Route header is
stored. When disabled, the received Service-Route header
is not stored.
terminalPortabilityInterworking - Controls Terminal
Portability Interworking service between ISUP and SIP.
When enabled, Terminal Portability Interworking service is
enabled. When disabled, Terminal Portability Interworking
service is disabled.
The service enables a terminal to be moved from one
socket to another or a call to be moved from one terminal
to another within one call while the call is active.
optionTagInR N/A
equireHeader
Suppress Replace Tag Flag. Controls the content in
Require headers to be sent to the peer. When enabled, the
REPLACE tag is suppressed in the Require header. If
disabled, the REPLACE tag is included in the Require
header.
If the Replaces header is present in a received SIP REFER
request, the SBC 5x00 includes the contents of the
Replaces header (callID, From Tag and To Tag) in the
outgoing INVITE without a full PSX query. This enables
one SBC 5x00 to be able to transfer two independent calls
and connect them together using IP trunk group (IPTG)
routing. IPTG routing must be enabled for this feature. This
control suppresses this feature.
Options are:
• disable
• enable
6–131
Profiles
Signaling
Parameter
Field
Length
optionTagInS N/A
upportedHead
er
Description
OptionTag In Supported Header. Controls the content in
Supported headers to be sent to the peer. When enabled,
the REPLACE tag is suppressed in the Supported header.
If disabled, the REPLACE tag is included in the Supported
header.
If the Replaces header is present in a received SIP REFER
request, the SBC 5x00 includes the contents of the
Supported header (call ID, From Tag and To Tag) in the
outgoing INVITE, OPTIONS, and INVITE/OPTIONS
without a full PSX query. This enables one SBC 5x00 to be
able to transfer two independent calls and connect them
together using IP trunk group (IPTG) routing. IPTG routing
must be enabled for this feature. This control suppresses
this feature.
Options are:
• disable
• enable
6–132
Signaling
Profiles
Parameter
Field
Length
relayFlags
N/A
Description
dialogEventPackage - Specifies the Dialog Event Package
Flag.
When this flag is enabled, the SBC 5x00 sends the Dialog
Event Package to the peer. When this flag is disabled, the
SBC 5x00 does not send the Dialog Event Package to the
peer.
dtmfBody - Controls the relay mode for the DTMF body for
responses to INVITE and BYE messages, relayed INFO,
REFER, NOTIFY, OPTIONS, and SUBSCRIBE request
messages, and relayed 3xx, 4xx, 5xx, and 6xx responses
to INVITE messages.
When enabled, the SBC 5x00 relays the DTMF body to
the peer. When disabled, the SBC 5x00 does not relay the
DTMF body.
This flag needs to be provisioned on the ingress leg with
respect to the message direction.
info - Controls the relay mode for the SIP INFO method.
When enabled, the SBC 5x00 relays SIP INFO messages
to the peer. When disabled, the SBC 5x00 processes SIP
INFO messages locally.
message - Controls the relay mode for the SIP MESSAGE
method, which is used to allow the transfer of instant
messages (IMs). When enabled, the SBC 5x00 relays SIP
MESSAGE messages to the peer. When disabled, the
SBC 5x00 processes SIP MESSAGE messages locally.
notify - Controls the relay mode for the SIP NOTIFY
method. When enabled, the SBC 5x00 relays SIP NOTIFY
messages to the peer. When disabled, the SBC 5x00
processes SIP NOTIFY messages locally.
options - Controls the relay mode for the SIP OPTIONS
method. When enabled, the SBC 5x00 relays SIP
OPTIONS messages to the peer. When disabled, the SBC
5x00 processes SIP OPTIONS messages locally.
refer - When enabled, the SBC 5x00 relays SIP REFER
messages to the peer. When disabled, the SBC 5x00
processes SIP REFER messages locally.
regEventPackage - Registration Event Package Flag.
sonusMediaBody - Controls the relay mode for the Sonus
media body for responses to INVITE and BYE messages,
relayed INFO, REFER, NOTIFY, OPTIONS, and
SUBSCRIBE request messages, and relayed 3xx, 4xx,
5xx, and 6xx responses to INVITE messages.
When enabled, the SBC 5x00 relays the Sonus media
the peer. When disabled, the SBC 5x00 does not
relay
the
Sonus media body.
body to
6–133
Profiles
Signaling
Parameter
relayFlags
(continued)
Field
Length
N/A
Description
statusCode3xx - Controls the relay mode for the 3xx
status code for the responses to INVITE requests.
When enabled, the SBC 5x00 relays the 3xx status code to
the peer. When disabled, the SBC 5x00 does not relay the
3xx status code.
This flag needs to be provisioned on the trunk group that
receives the 3xx response, which is the egress leg of the
call.
statusCode4xx6xx - Controls the relay mode for the error
status code (4xx, 5xx, or 6xx) for the responses to initial
INVITE requests (does not apply to re-INVITEs).
When enabled, the SBC 5x00 relays the error status code
to the peer. Note: Flag statusCode4xx6xx relay must be
enabled if authcodeHeaders transparency is used.
When disabled, the SBC 5x00 does not relay the error
status code.
This flag needs to be provisioned on the trunk group that
receives the error response, which is the egress leg of the
call.
thirdPartyBodies - Controls the relay mode for third
party bodies for responses to INVITE and BYE messages,
relayed INFO, REFER, NOTIFY, OPTIONS, and
SUBSCRIBE request messages, and relayed 3xx, 4xx,
5xx, and 6xx responses to INVITE messages.
When enabled, the SBC 5x00 relays third party bodies to
the peer. When disabled, the SBC 5x00 does not relay
third party bodies.
6–134
Signaling
Profiles
Parameter
Field
Length
transparency N/A
Flags
Description
alertInformationHeader -Controls ALERT INFO header
transparency in SIP INVITE messages. When enabled, the
SBC 5x00 transparently copies the ALERT INFO header
from the ingress SIP INVITE message to the egress SIP
INVITE message. When disabled, the SBC 5x00 does not
copy the header.
authcodeHeaders - Controls authorization-related
transparency. When enabled, the SBC 5x00 transparently
copies the WWW Authentication header for SIP 401/407
response messages or SIP Authorization/Proxy
Authorization headers. When disabled, the SBC 5x00 does
not copy the headers.
contactHeader - Specifies the Contact Header Flag.
errorInfo - Controls Error-Info header transparency in
INVITE requests and their responses (if relayed). When
enabled, the SBC 5x00 transparently copies the Error-Info
header from the ingress leg to the egress leg. When
disabled, the Error-Info header is not copied.
This flag needs to be provisioned on the egress leg with
fromHeader - Controls FROM header transparency in SIP
INVITE messages. When enabled, the SBC 5x00
transparently copies the userinfo@host component of the
FROM header from the ingress SIP INVITE message to
the egress SIP INVITE message. When disabled, the SBC
5x00 does not copy the userinfo@host component.
NOTE
Even when this flag is enabled,
the IP port information is not
included unless the “Include IP
Ports in From and To Headers”
flag, elsewhere in this IP
Signaling Profile, is also enabled.
maxForwardsHeader - Controls Max-Forwards header
transparency in the following requests and their responses
if they are relayed: INVITE, REGISTER, BYE, INFO,
OPTIONS, NOTIFY, REFER, and SUBSCRIBE.
When enabled, the SBC 5x00 transparently copies the
Max- Forwards header from the incoming message to the
outgoing message. When disabled, the SBC 5x00 does not
copy the header.
mwiBody - Controls MWI Body transparency in the
following requests and their responses if they are relayed:
INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY,
REFER, and SUBSCRIBE.
MWI body from the incoming message to the outgoing
message. When disabled, the SBC 5x00 does not copy the
6–135
Profiles
Signaling
Parameter
Field
Length
transparency N/A
Flags
(continued)
Description
pChargingVectorHeader - Controls P-Charging-Vector
header transparency in outgoing SIP messages. When
enabled, the SBC 5x00 transparently copies the PCharging-Vector header from the ingress message to the
egress message. When disabled, the SBC 5x00 does not
copy the header. PCharging- Vector header transparency
is supported in INVITE, REGISTER, SUBSCRIBE,
OPTIONS, NOTIFY, REFER, and INFO messages, and is
relayed in 4xx, 5xx, and 6xx responses.
The P-Charging-Vector header contains the ICID value,
which is used to correlate charging records among Sonus
entities.
pEarlyMedia - Controls P-Early Media header
transparency in INVITE or non-100 RESPONSE requests
and their responses if they are relayed. When enabled,
SBC 5x00 transparently copies the P-Early Media header
from the incoming message to the outgoing message.
When disabled, the PEarly- Media header is not copied to
the egress leg.
Provision this flag on the egress leg (with respect to the
message direction).
pathHeader - Controls Path header transparency in SIP
messages. When enabled, the SBC 5x00 transparently
copies the Path header from the ingress SIP message to
the egress SIP message. When disabled, the SBC 5x00
does not copy the header.
qsigBody - Controls QSIG body transparency in the
QSIG body from the incoming message to the outgoing
QSIG body.
reasonHeader - When enabled, the ingress Reason
header value is passed through unchanged.
referredByHeader - When enabled, SBC 5x00
transparently copies the Referred-By Header (in INVITE
requests/responses) from the incoming message to the
outgoing message. When cleared, the Referred-By Header
is not copied.
6–136
message direction).
Signaling
Profiles
Parameter
Field
Length
transparency N/A
Flags
(continued)
Description
requestURI - Controls Request URI transparency in
INVITE, REGISTER, SUBSCRIBE/NOTIFY, and their
responses when they are relayed. When enabled, SBC
5x00 transparently copies the Request URI from the
incoming message to the outgoing message. When
disabled, the Request URI is not copied to the egress leg.
message direction).
routeHeader - Controls Route header transparency in SIP
messages. When enabled, the SBC 5x00 transparently
copies the Route header from the ingress SIP message to
the egress SIP message. When disabled, the SBC 5x00
does not copy the header.
serviceRouteHeader - Controls Service-Route header
transparency in SIP messages. When enabled, the SBC
5x00 transparently copies the Service-Route header from
the ingress SIP message to the egress SIP message.
When disabled, the SBC 5x00 does not copy the header.
sipBody - Controls SIP body transparency in the following
requests and their responses if they are relayed: INVITE,
REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and
SUBSCRIBE.
When enabled, the SBC 5x00 transparently copies the SIP
body from the incoming message to the outgoing
SIP body.
sipfragBody - Controls SIPFRAG body transparency in
the following requests and their responses if they are
relayed: INVITE, REGISTER, BYE, INFO, OPTIONS,
NOTIFY, REFER, and SUBSCRIBE.
SIPFRAG body from the incoming message to the
copy the SIPFRAG body.
toHeader - Controls TO header transparency in SIP
INVITE messages. When enabled, the SBC 5x00
transparently copies the userinfo@host component of the
TO header from the ingress SIP INVITE message to the
egress SIP INVITE message. When disabled, the SBC
5x00 generates its own TO header.
6–137
Profiles
Signaling
Parameter
Field
Length
transparency N/A
Flags
(continued)
Description
NOTE
Even when this flag is enabled,
the IP port information is not
included unless the “Include IP
Ports in From and To Headers”
flag, elsewhere in this IP
Signaling Profile, is also enabled.
historyInfo - Controls History-info header transparency
in SIP INVITE messages. When enabled, the SBC 5x00
passes the History-Info header transparently from the
ingress message to the egress message. When disabled,
the SBC 5x00 does not copy the history-info.
toneBody - Controls Tone body transparency in the
Tone body from the incoming message to the outgoing
Tone body.
unknownBody - Controls Unknown body transparency in
the following requests and their responses if they are
Unknown body from the incoming message to the outgoing
Unknown body.
unknownHeader - Controls Unknown header transparency
in the following requests and their responses if they are
Unknown header from the incoming message to the
copy the Unknown header.
6–138
This flag needs to be provisioned
on the—egress
leg—with
550-05337
Version 0.3
Release V03.00.00
viaHeader - Specifies the source address of the call
originator. Options are:
Signaling
Profiles
Parameter
Field
Length
Description
transparency N/A
Flags
(continued)
- enable - Transparently pass through all the VIA
headers received in original INVITE or REGISTER.
With only the transparency flag enabled, SBC 5x00 will
still include the local SIP signaling address and port as
the top most VIA header.
- disable - Default behavior where IP address on the
via header is the local SIP signaling address.
displaylevel
1-64
commands.
Command Example
Egress IP attributes
This section lists CLI commands of SIP egress IP attributes for sending a call in
the forward direction to the peer.
Command Syntax
egressIpAttributes
bci <bci>
flags <flags>
isub <isub>
numberPortabilityAttributes <numberPortabilityAttributes>
privacy <privacy>
redirect <redirect>
sipHeadersAndParameters <sipHeadersAndParameters>
egressIpAttributes
bci <bci>
flags <flags>
isub <isub>
6–139
Profiles
Signaling
privacy <privacy>
redirect <redirect>
% delete profiles signaling ipSignalingProfile DEFAULT_SIP
egressIpAttributes
bci <bci>
flags <flags>
isub <isub>
privacy <privacy>
redirect <redirect>
Command Parameters
6–140
Signaling
Profiles
6–141
Profiles
Signaling
TABLE 6–25 IP Signaling Profile SIP egress Attributes
Parameter
Field
Length
Description
bci
N/A
Specifies the bci flag.
• bciInterworkEncountered - Enables or disables the BCI
Interwork Encountered Flag. SBC 5x00 sets the Interworking
Indicator bit in the BCI parameter of backward SS7 messages
(e.g., ACM or ANM).
• bciIsdnAddess - Enables or disables BCI ISDN Address
Flag. SBC 5x00 sets the ISDN Access Indicator bit in the BCI
parameter of backward SS7 messages (e.g., ACM or ANM).
6–142
Signaling
Profiles
Parameter
Field
Length
Description
domainName
N/A
Specified domain names.
• useSipDomainNameInFromField - Use SIP Domain Name
In From Field Flag. By default, a SBC 5x00 uses its IP address
as the host-port of the FROM URI in the outgoing INVITE
message. When enabled, the SBC 5x00 will use the
originating gateway information returned in the policy
response as the host-port of the FROM URI in the outgoing
INVITE message. If a SIP domain is configured for the ingress
trunk group, the default gateway associated with that SIP
domain will be the originating gateway. Otherwise, the
originating gateway will be the default gateway associated
with the SIP domain associated with the Softswitch entity
• useSipDomainNameInRequestUri - Use SIP Domain
Name In Request URI Flag.
Options are:
- disable - When the disabled, the SBC 5x00
includes the IP address in the host-port portion of the
Request-URI in outgoing SIP INVITE messages.
- enable - When the enabled, the SBC 5x00
includes the trunk group domain associated with the
egress trunk group as the destination domain name
in outgoing SIP INVITE messages. Options are:
- preserveIngressRUriDomainName Preserve Ingress R-URI Domain Name Flag.
When enabled, the PSX/SBC 5x00 uses the
domain name received in the Request-URI as the
destination domain name in outgoing SIP INVITE
messages. Normally, outgoing SIP INVITE
messages contain the trunk group domain
assigned to the egress trunk group. Options are:
enable, disable.
- useLowerCaseDomainNames - Use Lower
Case Domain Names Flag. This flag controls
whether the domain names in the Request-URI
and FROM header of outgoing SIP messages are
in upper or lower case. When enabled, the
domain names in the Request-URI and FROM
header are sent in lower case. When disabled,
the domain names are sent in upper case.
Options are: enable, disable.
6–143
Profiles
Signaling
Parameter
Field
Length
Description
flags
N/A
Specifies the flags for egress IP attributes.
• bgcfTargetSchemeTransparency - When enabled, the
SBC 5x00 preserves the scheme used by the SIP INVITE
Request-URI when the INVITE is routed by the SBC 5x00,
acting as a BGCF supporting Tel-URL. When disabled, the
SBC 5x00 changes the scheme used by the Request-URI
parameter to SIP in the egress INVITE message (this is the
default).
• convertInactiveToSendrecv - This flag is used by the
SBC 5x00 to control the a-line in the SDP of an egress SIP
INVITE message. When enabled, the SBC 5x00 converts
a=inactive to a=sendrecv in the egress INVITE message.
When disabled, the SBC 5x00 continues to use a=inactive,
when appropriate, in the egress INVITE message.
• disable2806Compliance - If enabled, the 2806
Compliance Code is disabled, and no phone context or
user=phone parameters are signaled in egress messages.
• disableOptionalRegisterParameters - Controls
whether the SBC 5x00 sends the DTG (Destination Trunk
Group) parameter in the Contact header of egress REGISTER
messages. When enabled, the SBC 5x00 does not send the
DTG parameter. When disabled, the SBC 5x00 sends the
DTG parameter.
• map181Or182MessageTo183 - This parameter is used by
the SBC 5x00 to control SIP response processing. When
enabled, the SBC 5x00 maps 181 or 182 response messages
to 183. When disabled, the SBC 5x00 handles 1xx response
messages normally.
• mapContractorNumberInPSigInfoHeader -When
enabled, the Contractor Number parameter will be mapped
into the outgoing SIP P-Sig-Info header. The P-Sig-Info
header is a customer-specific SIP header used to convey
ISUP information in SIP messages.
• suppressUnregister - When enabled, the SBC 5x00 does
not send an unregister message (Register=0) to the registrar
upon expiration of a SIP UA registration. When disabled
(default), the SBC 5x00 generates unregister messages on
the egress leg if the UA does not refresh the registration on
time.
• ttcIsupMapping - When enabled, and when the IP protocol
type of the IP signaling profile entry is SIP or SIP-I, the
application that receives the SBC 5x00 policy response (which
can be either the SIP signaling gateway application on the
SBC 5x00 or the SIP core proxy on the SBC 5x00) applies the
mapping necessary for TTC-ISUP signaling.
6–144
Signaling
Profiles
Parameter
flags
(continued)
Field
Length
N/A
Description
• useCalledPartyInRequestUri - When enabled, the SBC
5x00 copies the username that has been selected for the "To"
header to the Request URI instead of the registered
username. When disabled, the SBC 5x00 includes the
registered username in the Request URI. This flag is used by
the SBC 5x00 when interoperating with IP-PBXs that require
the real end station number in the Request URI in order to do
proper routing of calls terminating on them.
• useColonInSdpMediaTypeParameter - When enabled, a
colon (:) is used as the separator between the SDP Media
Type parameter key and value.
When disabled, an equal sign (=) is used as the separator
between the SDP Media Type parameter key and value.
•
isub
N/A
validateIsubAddress - When enabled, the SBC 5x00
validates ISUB digits for called and calling parties. When
disabled, the SBC 5x00 will not validate ISUB digits.
The possible options are:
•
•
allowNsapIsub - Allow NSAP ISUB flag.
allowUserSpecifiedIsub - Allow user specified ISUB
flag.
• includeCalledPartyIsub - Include called party ISUB
flag.
• includeCallingPartyIsub - Include calling party ISUB
flag.
numberGlobal N/A
izationProfi
le
Specifies the Number Globalize Profile. This profile
converts numbers to SIP global number format. The
default value is <none>.
6–145
Profiles
Signaling
Parameter
Field
Length
numberPortab N/A
ilityAttribu
tes
Description
Specifies the Number portability.
• disableRn - Disable rn Flag. Controls whether the SBC 5x00
and PSX SIP proxy/redirector send the SIP rn parameter in
the egress INVITE message when an LNP translated number
is present. When the disabled, the SBC 5x00 and PSX SIP
proxy/redirector send “rn=NNNN” in the userinfo portion of the
Request URI, where NNNN is the LNP translated number.
When the check enabled, the SBC 5x00 and PSX SIP proxy/
redirector do not send the rn parameter.
• npdiOptions - NPDI Options. The following options specify
whether the SBC 5x00 and PSX SIP proxy/ redirector send
the SIP npdi parameter in the egress INVITE message when
LNP translation has been performed either by PSX call
processing or by the preceding switch.
- doNotIncludeNpdi
- includeNpdi
- includeNpdiYes
When “Include npdi” is enabled, the SBC 5x00 and PSX
SIP proxy/redirector send “npdi” in the userinfo portion of
the Request URI. When “Include npdi=yes” is enabled, the
SBC 5x00 and PSX SIP proxy/redirector send “npdi=yes”.
When “Do Not Include npdi” is enabled, the SBC 5x00 and
PSX SIP proxy/redirector do not send the npdi parameter.
6–146
Signaling
Profiles
Parameter
Field
Length
Description
privacy
N/A
Specifies the privacy parameters.
• flags - Options are:
- includePrivacy - Include Privacy Flag. Specifies
whether the SBC 5x00 and PSX include privacy
information in outgoing SIP INVITE messages.
Options are:
enabled - If enabled, the SBC 5x00 will include
either a P-Preferred- Identity header or a PAsserted-Identity header (provisioned in Privacy
Information above) in outgoing SIP INVITE
messages. The PSX will include a P-AssertedIdentity header in outgoing SIP INVITE messages.
The SBC 5x00 will also insert an Anonymous
identifier in the SIP From field and the SBC 5x00
and PSX will include a Privacy header that contains
a Critical token.
disabled - If disabled, the SBC 5x00 will not
include a P-Preferred-Identity header or a PAsserted-Identity header, an Anonymous identifier
in the SIP From field, or a Privacy header that
contains a Critical token in outgoing SIP INVITE
messages, and the PSX will not include a PAsserted-Identity header or a Privacy header that
contains a Critical token in outgoing SIP INVITE
messages.
- msLyncPrivacySupport - Specifies the
backward compatibility for the Caller Privacy feature.
Only if you enable this flag, the Caller privacy feature
will work or the Caller Privacy feature does not work.
This flag can be enabled or disabled.
- privacyRequiredByProxy - Privacy Required
by Proxy Flag. If enabled, indicates that privacy
service is mandated for any calls to the SIP trunk
(proxy). In this case the SBC 5x00 will include a
Proxy-Require header with a privacy value, and a
critical token in the Privacy header of the INVITE
message. The privacy service must be applied by the
proxy or the call will be rejected. If disabled, the SBC
5x00 will not include a Proxy-Require header with
privacy value. The proxy will accept the call even if it
cannot provide privacy service. The default setting is
“not required”.
• privacyInformation - Privacy Information Flag. Specifies
which of the following headers the SBC 5x00 will use when
sending privacy information in outgoing SIP INVITE
messages:
- P-Preferred-ID—Used by a User Agent (UA) to carry
the identity the caller wishes to be used, and sent to a
trusted
proxy toAllbeRights
inserted
in the
P-Asserted-Identity
and Proprietary.
Reserved.
Do not
distribute without permission.
field.
- P-Asserted-ID—Used among trusted SIP entities
6–147
Profiles
Signaling
Parameter
privacy
(continued)
Field
Length
N/A
Description
- Remote-Party-ID—Used among trusted SIP entities
(typically intermediaries) to carry the identity of the
caller as it was verified by authentication. This header
is specified in an earlier RFC that continues to be
supported. This flag can be enabled or disabled.
• transparency - Transparency Flag. When enabled, the
ingress Privacy information is passed through unchanged.
This flag can be enabled or disabled.
6–148
Signaling
Profiles
Parameter
Field
Length
Description
redirect
N/A
Specifies the redirect parameters.
• contactHandling - Contact Handling. Select one of the
following to control processing of contacts received in SIP
Redirects:
- mergeReceivedContacts - Merge Received
Contacts with Existing Contacts—Contacts received
in Redirects are ordered by q-value and inserted at
the head of the list of untried contacts.
- purgeExistingContacts - Purge Existing
Contacts—Contacts received in Redirects are
ordered by q-value and replace untried contacts
• flags - Options are:
- forceRequeryForRedirection - Force Requery
for Redirection Flag. Options are:
- enable - If enabled, SBC 5x00 will re-query PSX
(ERE) with the contact information received in the
3xx response in redirection scenarios.
- disable - Default value is disable.
- skipCrankbackProfileAndAlwaysCrankback Skip Crankback Profile and always Crankback Flag.
Options are:
- enable - When enabled, this flag causes any 4xx
- 6xx SIP response code to cause crankback such
that the next potential contact or route is tried.
- disable - If disabled, only the response codes
specified in the default SBC 5x00 crankback profile
will cause the call to be cranked back. Default value
is disable.
• mode - Select one of the following options to control SIP
redirection:
- acceptRedirection - Multiple redirections are
allowed (default).
- allowSingleRedirectAttempt - Only a single
Redirect is allowed per route. Additional Redirects
cause crankback to be performed.
- rejectRedirection - If a Redirect is received,
crank back is performed.
6–149
Profiles
Signaling
Parameter
Field
Length
sipHeadersAn N/A
dParameters
Description
Specifies the SIP header parameters.
• callForwarding - This flag is used to control the call
forwarding data mapping method in egress SIP signaling.
Options are:
- dataMapping - Options are:
- diversion
- purgeExistingContacts
- diversionHeaderTransparency - When
enabled, the ingress Diversion header is passed
through unchanged. Call forwarding data mapping
transparency applies to Diversion header only. Options
are: disable enable
• destinationTrunkGroupOptions - This parameter
specifies the action to be taken regarding the destination trunk
group. Options are:
- includeDtg - include the destination trunk group
parameter in SIP headers sent over the associated
trunk group.
- includeNone - do not include any trunk group
information (default)
- includeTgrpWithDomainName - do not include
any trunk group information (default)
- includeTgrpWithIpAddress - include the
destination trunk group, and include the trunk context
as domain name.
flags - Options are:
- includeCic - Include CIC flag. If enabled, the
SBC 5x00 will include the Carrier Identification Code
in a cic= parameter in outgoing INVITE messages.
- includeCpcInformation - Include CPC
Information Flag. If enabled, the SBC 5x00 will
include the Calling Party Category (CPC) parameter
value in the From header of outgoing SIP INVITE
messages.
The CPC parameter characterizes the station used to
originate a call, such as ordinary, priority, data, test,
operator, payphone, prison, hotel or unknown.
- includeNpi - Include NPI flag. If enabled, the
SBC 5x00 will include the Numbering Plan.
Indicator in a npi= parameter in outgoing INVITE
messages.
6–150
Signaling
Profiles
Parameter
Field
Length
sipHeadersAn N/A
dParameters
(continued)
Description
- includeOlip - Include OLIP flag. If enabled, the
SBC 5x00 will include the Originating Line
Information Parameter in a oli= parameter in
outgoing INVITE messages.
- includePKAdn - Include P-K-Adn flag. Controls
whether the SBC 5x00 includes the P-K-Adn header
in egress SIP messages. When enabled, the SBC
5x00 includes the P-K-Adn header. When disabled,
the SBC 5x00 does not include the P-K-Adn header.
The P-K-Adn header is a customer-specific SIP
header used for ISUP-to-SIP interworking and
contains the Translation Source Number (TSN) used
in Number to SIP URL translation via the Number
Username Translation screen (Generic variant only).
- includePstnParameters - Include PSTN
parameters flag. If enabled, the SBC 5x00 will
include a set of specific PSTN parameters in a pstnparams= entry in outgoing INVITE messages. The
PSTN parameters currently included in pstn-params
are Screening Indicator, ISDN Indicator, and
Transmission Medium Requirement (TMR).
- includeQvalue - Include Qvalue Flag. If enabled,
the PSX SIP proxy/redirector includes the qvalue
parameter (for example, q=0.9) in the Contact header
of outgoing 3xx messages. If disabled, the PSX
proxy/redirector does not include the qvalue
parameter.
- skipCSeqCheckInEarlyDialog - Skip CSeq
Check In Early Dialog Flag. When enabled, the SBC
5x00 will accept multiple SIP requests in which the
CSeq number in a later request is of a lesser value
than the CSeq number received in earlier requests.
When disabled, the SBC 5x00 rejects such SIP
requests.
transparencyForDestinationTrunkGroupPar
ameter - Transparency for destination trunk group
parameter flag. When enabled (the default), if PSX
receives both tgrp parameter and trunk-context in an
ingress INVITE Request-URI, PSX as proxy
transparently passes the tgrp parameter and trunkcontext in the egress INVITE Request-URI. Values
selected for the "Destination Trunk Group Option" are
ignored. When disabled, the PSX does not
transparently pass tgrp and trunk-context
parameters, and the "Destination Trunk Group
Option" values are considered.
• includeChargeInformation - Include Charge
6–151
Information. When Include P-Charge-Info enabled, charge
information
that may
be present
in aDocall
message
(i.e.,
and Proprietary.
All Rights
Reserved.
notsetup
distribute
without permission.
the charge parameter of an IAM) is mapped into the PCharge-Info header in an outgoing SIP INVITE message. If
Profiles
Signaling
Parameter
Field
Length
sipHeadersAn N/A
dParameters
(continued)
Description
SBC 5x00 ensures that the P-Charge-Info header is
populated with the indicated data. If the SBC 5x00 receives
a SIP INVITE message for a call destined to the PSTN, the
SBC 5x00 populates the charge parameter of the outgoing
IAM based on the P-Charge-Info header. Options are:
- includeNone
- includePChargeInfo
• originatingTrunkGroupOptions - Originating Trunk
Group Options. This parameter specifies the action to be
taken regarding the originating trunk group. Options are:
- includeNone - do not include any trunk group
information (default).
- includeOtg - include the originating trunk group
parameter in SIP headers sent over the associated
trunk group.
- includeTgrpWithDomainName - include the
originating trunk group, and include the trunk context
as domain name.
- includeTgrpWithIpAddress - include the
originating trunk group, and include the trunk context
as IP address
transport
N/A
Specifies the transport parameter types:
•
•
•
•
type1 - Transport Type 1.
For each transport type, you can select any one of the
following transport protocol:
•
•
•
•
•
displaylevel
1-64
none
sctp
tcp
tlsOverTcp
udp
commands.
Ingress IP attributes
This section lists CLI commands of ingress IP attributes.
Command Syntax
6–152
Signaling
Profiles
ingressIpAttributes
carrierInformation <carrierInformation>
flags <flags>
ingressIpAttributes
flags <flags>
% delete profiles signaling ipSignalingProfile DEFAULT_SIP
ingressIpAttributes
flags <flags>
Command Parameters
Parameter
Field
Length
carrierInfor N/A
mation
Description
Specifies the carrier information parameters.
• generateTerminatingCa - Generate Terminating CA Flag.
This control is checked on the ingress SIP side to decide
whether to interwork the terminating CA data from ISUP to SIP
18x messages. When enabled, the SBC 5x00 maps the
terminating CA data from ISUP to SIP 18x messages. When
disabled, the SBC 5x00 does not map the terminating CA data
from ISUP to SIP 18x messages. This flag can be enabled or
disabled.
• generateTerminatingCic - Generate Terminating CIC
Flag. This control is checked on the ingress SIP side to decide
whether to interwork the terminating CIC data from ISUP to
SIP 18x messages. When enabled, the SBC 5x00 maps the
terminating CIC data from ISUP to SIP 18x messages. When
disabled, the SBC 5x00 does not map the terminating CIC
data from ISUP to SIP 18x messages. This flag can be
enabled or disabled.
6–153
Profiles
Signaling
Parameter
Field
Length
Description
flags
N/A
mapCalledPartyCategoryInPSigInfoHeader - When
enabled, the Called Party Category parameter will be
mapped into the outgoing SIP P-Sig-Info header.
The P-Sig-Info header is a customer-specific SIP header
used to convey ISUP information in SIP messages.
noSdpIn180Supported - By default, the SBC 5x00
includes SDP in outbound 180 messages.
When enabled, the SBC 5x00 does not include SDP in
outbound 180 messages. It converts the 180 message to a
183 message instead. When disabled, the SBC 5x00
includes SDP in outbound 180 messages.
registrationExpiresinExpiresHeader - Controls what
the SBC 5x00 signals back to a peer when it has received
a REGISTER message from that peer. When enabled,
SBC 5x00 inserts the Expires header in the message.
When disabled, SBC 5x00 does not insert the Expires
header.
registrationSupport3xx - When enabled, the SBC 5x00
redirects an initial REGISTER message to the egress leg
by sending a 3xx message to the ingress leg. When
disabled, the SBC 5x00 does not send a 3xx message to
redirect an initial REGISTER message.
send183OnInitiatingDisconnectTreatment - Controls
whether the SBC 5x00 sends a 183 message on initiating a
disconnect treatment. When enabled, the SBC 5x00 sends
a 183 message. When disabled, the SBC 5x00 does not
send a 183 message.
sendSdpIn200OkIf18xReliable - When enabled, the
SBC 5x00 sends SDP in final 200 OK response messages
when provisional 1 8x responses are reliable. When
disabled, the SBC 5x00 does not send SDP in final 200 OK
response messages.
sendSdpInSubsequent18x - When enabled, the SBC 5x00
sends SDP in subsequent 1 8x response messages. When
disabled, the SBC 5x00 may not send SDP in subsequent
1 8x response messages.
sip181Supported - When enabled, the SBC 5x00
supports SIP 181 Call Is Being Forwarded messages in the
backward direction. It is provisioned on the ingress trunk
group.
sip182Supported -When enabled, the SBC 5x00 supports
SIP 182 Queued messages in the backward direction. It is
provisioned on the ingress trunk group.
6–154
Signaling
Profiles
Parameter
Field
Length
displaylevel
1-64
Description
commands.
Command Example
Configuring SIP Over TCP
To configure SIP over TCP:
1. Select TCP as a transport parameter in ipSignalingProfile and assign it
to the egress sip trunk group.
% set profiles signaling ipSignalingProfile SIP_IPSIGPROF
ingressIpAttributes transport type1
none
sctp
tcp - For SIP Over TCP call
tlsOverTcp - For SIP Over TLS Call
udp – For SIP Over UDP Call
2. Select tcp for SIP over TCP calls by executing:
ingressIpAttributes transport type1 tcp
3. Assign this IP signaling profile to sip trunk groups:
% set addressContext a1 zone EXTERNAL sipTrunkGroup
EXT_NET policy signaling ipSignalingProfile
SIP_IPSIGPROF
4. If ipSignalingProfile is not configured for any transport protocols (if
transport type1 is none), SIP call over TCP can be forced by configuring the
transport preference on egress sipTrunkGroup:
EXT_NETWORK signaling transportPreference preference
preference1 - This first choice of transport protocol for
SIP calls.
preference2 - This second choice of transport protocol
for SIP calls.
preference3 - This third choice of transport protocol for
SIP calls.
6–155
Profiles
Signaling
preference4 - This fourth choice of transport protocol
for SIP calls.
5. Select TCP.
EXT_NETWORK signaling transportPreference preference1
tcp
Configuring SIP Over TLS
To configure SIP over TLS:
1. Generate client and server certificates (clientCert.der and server.p12) and
place it in a folder /opt/sonus/external/. To transfer files, refer to "Transferring
Files to the system" on page 7–6.
2. Install server certificates:
% set system security pki certificate server type local
fileName server.p12 passPhrase NBS5200 state enabled
% set system security pki certificate client type remote
fileName clientCert.der state enabled
3. Check the status of the installed certificates:
> show status system security pki certificate
The output displayed similar to the following:
certificate client {
state
enabled;
fileName clientCert.der;
type
remote;
}
certificate server {
state
enabled;
fileName
server.p12;
passPhrase gsx9000;
type
local;
}
4. Assign the installed certificates to the TLS profile:
% set profiles security tlsProfile defaultTlsProfile
serverCertName server clientCertName client
5. Assign TLS to the sip signaling ports:
% set addressContext a1 zone EXTERNAL sipSigPort 1 state
disabled
6–156
Signaling
Profiles
% set addressContext a1 zone EXTERNAL sipSigPort 1
tlsProfileName defaultTlsProfile
% set addressContext a1 zone EXTERNAL sipSigPort 1 state
enabled
% set addressContext a1 zone INTERNAL sipSigPort 2 state
disabled
% set addressContext a1 zone INTERNAL sipSigPort 2
tlsProfileName defaultTlsProfile
% set addressContext a1 zone INTERNAL sipSigPort 2 state
enabled
6. For TLS call, select tlsOverTcp in ipSignalingProfile:
set profiles signaling ipSignalingProfile SIP_IPSIGPROF
The output displayed similar to the following:
none
sctp
tcp - For SIP Over TCP call
tlsOverTcp - For SIP Over TLS Call
udp – For SIP Over UDP Call
7. Assign the ipSignalingProfile to SIP Trunk Groups:
EXT_NET policy signaling ipSignalingProfile
SIP_IPSIGPROF
IP Protocol Type attributes
This section lists CLI commands of IP protocol type attributes.
Command Syntax
ipProtocolType <ipProtocolType>
ISUP Signaling Profile
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 the
following command:
% show profiles signaling isupSignalingProfile
<isupSignalingProfile>
6–157
Profiles
Signaling
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 % set
profiles signaling isupSignalingProfile
<isupSignalingProfile> and set the baseProfile to the appropriate
default profile when you set your new profile.
Command Syntax
% set profiles signaling isupSignalingProfile
% show profiles signaling isupSignalingProfile
% delete profiles signaling isupSignalingProfile
Command Parameters
TABLE 6–27 ISUP Signaling Profile parameters
Parameter
Field
Length
isupSignalin N/A
gProfile
Description
Specifies the name of the ISUP profile. Must be 1-23
characters. The following are the default ISUP profiles:
•
•
•
•
•
•
•
•
•
accessDelivery N/A
ansi00
ansi88
etsi12
etsi35
gr317
itu-t88
itu-t92+
ttc87
ttc93+
Specifies whether the access delivery information is
supported for the ISUP Signaling Profile. Options are:
• unSupported
• supported
6–158
Signaling
Profiles
TABLE 6–27 ISUP Signaling Profile parameters (Continued)
Parameter
Field
Length
accessTransInF N/A
ar
Description
Specifies whether the access transport parameter is
supported in the FAR for the ISUP Signaling Profile:
• unSupported
• supported
accessTranspor N/A
t
supported for the ISUP Signaling Profile.
• unSupported
• supported
accessTranspor N/A
tInFac
supported in the FAC for the ISUP Signaling Profile:
• unSupported
• supported
addInfoTransfe N/A
r
Specifies additional Info Transfer Parameters are not
decoded and transited.
• unSupported
• supported
adpNumber
N/A
ADP Number Parameters are not decoded and transited
• unSupported
• supported
ait
N/A
Specifies whether the AIT is supported for the ISUP
Signaling profile:
• unsupported
• supported
allianceScree N/A
nInd
Specifies whether the Alliance Screen Indicator parameter
is supported for the ISUP Signaling profile:
• unsupported
• supported
allowCaForAnn N/A
ouncements
Specifies whether the allow charge area parameter for
announcements are supported for the ISUP Signaling
profile:
• unsupported
• supported
allowCallsOnH N/A
wBlock
Specifies that the calls must not be rejected on a hardware
blocked circuit:
• unsupported
• supported
6–159
Profiles
Signaling
Parameter
Field
Length
allowUnscreen N/A
edCin
Description
Specifies whether the values 0 and 2 of the Screening
Indicator should be allowed in the ISUP Signaling profile:
• unsupported
• supported
alwaysAddCnId N/A
Specifies whether the alwaysAddCnId - PROTOCOLS Japan DEFAULT - UNSUPPORTED SUPPORTED - when
interworking with SIP and the calling party number is
restricted then the cause of no ID parameter is included in
the IAM even if there is no parameter data received from
SIP.
alwaysAddOpti N/A
onalPtr
Specifies whether the optional parameter pointer should
always be added into ISUP messages even when no
optional parameters are defined:
• unsupported
• supported
announcementI N/A
nd
Specifies whether the announcement indicator parameter
is supported for the ISUP Signaling Profile:
• unsupported
• supported
ansi95Cfn
N/A
Specifies whether the ANSI-95 format for Confusion (CFN),
which includes optional parameters should be used.
• unsupported
• supported
ansi95Cqm
N/A
Specifies whether the ANSI 95 version of the CQM
message containing the optional pointer is supported for
the ISUP Signaling Profile:
• 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
apm
N/A
Specifies whether the APM is supported for the ISUP
Signaling profile:
• unsupported
• supported
6–160
Signaling
Profiles
Parameter
Field
Length
assumeOutgoing N/A
DeviceIncluded
Description
Specifies if an egress echo cancellation software assume
for an ISUP transit call that an outgoing device has been
included, regardless of the NCI setting:
• unsupported
• supported
atRel
N/A
Specifies whether the AT is supported in the REL for the
ISUP Signaling profile:
• unsupported
• supported
awaitTwoGroup N/A
Msgs
Specifies whether the flag must be set to await two group
messages in the ISUP Signaling Profile:
• unsupported
• supported
backwardGvns
N/A
Specifies whether the backward GVNS parameter is
supported for the ISUP Signaling Profile:
• unsupported
• supported
baseProfile
N/A
Specifies the Base Signaling group profile name. The
•
•
•
•
•
•
•
•
•
baseVersion
N/A
defaultRfc3204Ansi00
defaultRfc3204Ansi88
defaultRfc3204Etsi121
defaultRfc3204Etsi356
defaultRfc3204Gr317
defaultRfc3204ItuT88
defaultRfc3204ItuT92
defaultRfc3204Ttc87
defaultRfc3204Ttc93
Specifies the version of the Base Signaling group from
rfc3204. The possible values are:
•
•
•
•
•
•
•
•
•
•
ansi00
ansi88
etsi121
etsi356
gr317
itut88
itut92
none
ttc87
ttc93
6–161
Profiles
Signaling
Parameter
Field
Length
bbIam
N/A
Description
Specifies whether the User-To-User indicator parameter is
supported in IAM for the ISUP Signaling Profile.
• unsupported
• supported
bciInCpgWithCi N/A
t
Specifies that the BCI is only in CPG if the CIT is in the
message.
• unsupported
• supported
bciRel
N/A
Specifies whether the BCI is supported in the REL for the
ISUP Signaling Profile.
• unsupported
• supported
N/A
bcm
Specifies whether the Backwards Charging Message is
supported for the ISUP Signaling Profile.
bloAfterSetup N/A
Indicates that for some ANSI protocols a BLO message
should be sent when blocking a circuit, after a backwards
message has been received during the call.
blueBookInRel N/A
Specifies whether the Blue Book parameters are supported
in REL for the ISUP Signaling Profile.
buildRdiForSip N/A
Iwk
When interworking with SIP and the IAM contains the
original called number and redirecting number parameters
but no redirecting information parameter the SBC 5x00 will
generated one with the following values.
businessGroup N/A
Specifies whether the Business Group parameter is
supported for the ISUP Signaling profile.
callDiversion N/A
Specifies whether the call diversion is supported for the
ISUP Signaling profile.
callDiversion N/A
Treatment
Specifies whether the call diversion treatment parameter is
callHistory
N/A
Specifies whether the call history parameter is supported
for the ISUP Signaling profile.
callModMsgs
N/A
Specifies that the CMR, CMA and CMRJ are the call mod
messages supported for the ISUP Signaling profile.
callOfferingT N/A
reatment
Indicates that the call offering treatment parameter is
callReference N/A
Indicates that the call reference parameter is supported for
the ISUP Signaling profile.
callReference N/A
Frj
Indicates that the call reference parameter is supported in
the FRJ message.
6–162
Signaling
Profiles
Parameter
Field
Length
Description
callTransferN N/A
umber
Indicates that the call transfer number parameter is
callTransferR N/A
eference
Indicates that the call transfer reference parameter is
N/A
Indicates that the called Subs Basic Service Marks
parameter is supported for the ISUP Signaling profile.
calledBsm
calledDirecto N/A
ryNumber
calledInNum
N/A
calledNoa8For N/A
Np
Indicates that the called directory number parameter is
Indicates that the called IN number parameter supported
The Called Noa value 8 will not be supported
• unsupported
• supported
calledTfm
N/A
Indicates that the Called Subs Term Facility Marks
callingBsm
N/A
Indicates that the Calling Subs Basic Service Marks
callingOfm
N/A
Indicates that the Calling Subs Orig Facility Marks
carrierSelect N/A
ion
Indicates that the carrier selection is supported for the
causeInCpg
N/A
Indicates that the cause parameter supported in the CPG
causeInRlc
N/A
Indicates that the cause parameter is supported in the RLC
ccl
N/A
Indicates that the Calling Party Clearing (CCL) message is
supported.
ccnr
N/A
Indicates that the CCNR Possible Indicator parameter is
ccss
N/A
Indicates that the CCSS parameter supported for the ISUP
Signaling profile.
cellularCpcs
N/A
Calling Party Category values Cellular and Cellular
Roaming are not recognized.
cfn
N/A
Indicates that the CFN is supported for the ISUP Signaling
profile.
6–163
Profiles
Signaling
Parameter
Field
Length
chargeIndSett N/A
ing
Description
Sets the BCI charge indicator to either charge or no
charge, or will transit whatever is received from the
sending side (egress of network). Options are:
•
•
•
•
charge
noCharge
noIndication
transit
chargeMsgInSp N/A
eech
Indicates that the charge Message In Speech Parameter is
N/A
Indicates that the Charge Number parameter is supported
checkIxcAgains N/A
tTlec
SBC 5x00 will add in IXC data with the same carrier code
as the TLEC information.
chargeNumber
• unsupported
• supported
chgBetweenAcmA N/A
ndAnm
PROTOCOLS - Japan DEFAULT - SUPPORTED.
chgMsgBeforeA N/A
cm
The SBC 5x00 will not transit the CHG message in the
backward direction before an ACM has been received.
ci
N/A
Specifies whether the CI6 is supported in the ISUP
Signaling profile.
circuitAssign N/A
mentMap
Specifies whether the circuit assignment map parameter is
citTermExchan N/A
geLogic
Specifies that the CIT and CAI are in first backward
message when terminating exchange.
collectCallRe N/A
q
Specifies that the collect call request parameter is
com
N/A
comapatibilit N/A
y
Specifies whether the COM message is supported for the
Specifies whether the compatibility is supported for the
N/A
Specifies whether the CON message is supported before
an ACM is transited.
conferenceTre N/A
atment
Specifies whether the conference treatment parameter is
conferenceTre N/A
atmentInAnm
Specifies whether the Conference Treatment parameter in
the ANM is supported for the ISUP Signaling profile.
connectedNumb N/A
er
Specifies if the connected number is supported for the
ISUP signaling profile.
con
6–164
Signaling
Profiles
Parameter
Field
Length
Description
connectedNumb N/A
erInAcm
Specifies if the connected number parameter is supported
in the ACM for the ISUP Signaling profile.
connectedNumb N/A
erInCpg
Specifies if the connected number parameter is supported
in the CPG for the ISUP Signaling profile.
connectionPoi N/A
ntTrunkType
Specifies if the Connection Point Trunk Type is supported
connectionReq N/A
Specifies whether the Connection Request parameter is
conectionReqI N/A
nFaa
Specifies whether the connection request parameter is
supported in the FAA for the ISUP Signaling profile.
conectionReqI N/A
nFar
supported in the FAR for the ISUP Signaling profile.
conectionReqI N/A
nIam
supported in the IAM for the ISUP Signaling profile.
conectionReqI N/A
nInf
Specifies whether the connection request is supported in
the INF for the ISUP Signaling profile.
continuity
N/A
correlationId N/A
Specifies if the Continuity procedures are supported for the
Specifies whether the correlation ID parameter supported
cpgBeforeAcm
N/A
Specifies a CPG arriving before an ACM be transited.
cpnRel
N/A
Specifies whether the CPN is supported in the REL for the
cqmCqr
N/A
Specifies if the CQM/CQR is supported for the ISUP
Signaling profile.
cqmForResync
N/A
Specifies that a Cqm pdu is sent to resync when
transitioning from Mtp Pause to Resume State.
cqmOnCardSwap N/A
Specifies that the flag must be set for CQM on Card Swap
in the ISUP Signaling profile.
cugInterlockC N/A
ode
Indicates if the Closed User Group Interlock Code must be
supported for the ISUP signaling profile.
cvtCvr
N/A
Specifies whether the Circuit Validation Test/Response
procedures are supported for the ISUP Signaling profile.
diagnostics
N/A
Indicates that the Diagnostics field is supported for the
ISUP signaling profile.
dialedNumber
N/A
Indicates that the Dialed Number parameter is supported
discardContra N/A
ctorNum
The SBC 5x00 will not discard the Contractor number
parameter in the IAM (SBB specific) IAM message.
6–165
Profiles
Signaling
Parameter
Field
Length
Description
displayInfoIn N/A
Acm
Indicates that the Display Information parameter in the
ACM is supported for the ISUP Signaling profile.
displayInfoIn N/A
Con
CON is supported for the ISUP Signaling profile.
displayInfoCp N/A
g
CPG be supported for the ISUP Signaling profile.
displayInfoIa N/A
m
Indicates that the display Information parameter in the IAM
is supported for the ISUP Signaling profile.
displayInform N/A
ation
Indicates that the display information parameter is
N/A
Indicates that the DMS FE field should be supported for the
dontClearCdrF N/A
ields
Clear called Charge Area and/or Charging Rate when
Charge Information delay parameter is received in ACM or
CPG.
dontGenerateD N/A
iags
Indicates that the diagnostics should not be generated for
JAPAN.
dontMapToHead N/A
erToOcn
Indicates when interworking between SIP and ISUP the To
header field should not be interworked to the ISUP original
called number parameter.
dmsFe
dontSendExm
N/A
Specifies whether to send EXM messages on a trunk
group.
dpc
N/A
Specifies whether to transit the DPC Parameter:
dpcInformati N/A
on
Specifies whether to support the DPC Information
parameter received in the IAM.
dropCauseInA N/A
cmWhenIwk
Specifies that the CAUSE parameter in ACM must be
suppressed if announcement is played after interworking.
dropUsiFromN N/A
onIsup
Specifies that the USI parameter is supported when the farside is not ISUP.
drs
N/A
Specifies that DRS is supported the ISUP Signaling Profile.
displaylevel
1-64
commands.
Number Globalization Profile
Use this object to define numbers that are to be globalized for egress SIP
message headers. Specify a profile entry for each number type that needs to be
globalized. The profile includes a digit type, a source for the country code, and a
flag to enable the globalization.
6–166
Signaling
Profiles
Command Syntax
% set profiles signaling numberGlobalizationProfile
<numberGlobalizationProfile> entry <entry>
countryCodeSource <countryCodeSource>
globalize <globalize>
% show profiles signaling numberGlobalizationProfile
<numberGlobalizationProfile>
entry <entry>
countryCodeSource <countryCodeSource>
globalize <globalize>
% delete profiles signaling numberGlobalizationProfile
6–167
Profiles
Signaling
Command Parameters
TABLE 6–28 Number Globalization Profile parameters
Parameter
Field
Length
numberGlobal 1-23
izationProfi
le
entry
N/A
Description
Specifies the name of the Globalize Number Profile data. Must
be 1-23 characters.
Specifies a unique identifier for the globalize profile. The
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
entry
6–168
N/A
252
253
254
billingNumber
calledInNumber
calledNumber
callingNumber
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnCollectCallNumber
gnDestination
gnDialedDigits
gnLocalAni
gnPortedDialed
gnThirdPartyNumber
location
none
• outpulseNumber
• presentationNumber
• pretranslated
Signaling
Profiles
TABLE 6–28 Number Globalization Profile parameters (Continued)
Parameter
Field
Length
Description
entry
• redirecting
• twoStageCollected
countryCodeSou N/A
rce
Specifies the number type of the country code used to
globalize the number. The possible values are:
• destination
• ingressTrunkgroup
• origination
digitType
N/A
Specifies the digit type of the number to be globalized. The
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
900PremiumToll
950CarrierAccess
all
carrierAccess
directoryAssistance
easilyIdentifiableNumber
emergency
governmentEmergency
ieps
internationalType
ipVpn
localOperator
nationalOperator
nationalType
noDigits
otherCarrierChosen
private
serviceAccessCode
subscriberOperator
subscriberType
test
tollFree
transit
userName
verticalServiceCode
6–169
Profiles
Signaling
TABLE 6–28 Number Globalization Profile parameters (Continued)
Parameter
Field
Length
globalize
N/A
Description
Indicates the flag which turns on or off the globalization
feature for the number. Options are:
• disable - Do not globalize.
• enable - Perform number globalization.
displaylevel
1-64
commands.
Command Example
numberGlobalizationProfile DEFAULT_IP
{
entry callingNumber
{
digitType
subscriberType,nationalType,internationalType,easilyIdent
ifiableNumber,tollFree,900PremiumToll,950CarrierAccess,di
rectoryAssistance,serviceAccessCode,test,transit,otherCar
rierChosen,carrierAccess,noDigits;
countryCodeSource origination;
globalize
enable;
}
entry calledNumber
{
digitType
countryCodeSource destination;
globalize
enable;
}
entry pretranslated {
digitType
countryCodeSource destination;
globalize
6–170
enable;
Signaling
Profiles
}
SIP Adaptor Profile
The SIP Adaptor Profile object is the main construct for the SIP Message
Manipulation (SMM) functionality. A SIP Adaptor Profile is associated with a SIP
Trunk Group in order to act upon SIP messages passing into or out of that group.
A SIP Trunk Group can have two SIP Adaptor Profiles, input adaptor profile for
manipulation of inbound messages, output adaptor profile for manipulation of
outbound messages.
Command Syntax
// Mandatory parameters to configure a SIP Adaptor profile
% set profiles signaling sipAdaptorProfile <name> rule
<ruleId>
action <actionId>
applyMatchHdrRange <applyMatchHdrRange>
applyMatchHeader <applyMatchHeader>
criterion <criterionId>
% set profiles signaling sipAdaptorProfile <name> state
<state>
% show profiles signaling sipAdaptorProfile <name>
rule <ruleId>
state <state>
Command Parameters
TABLE 6–29 SIP Adaptor Profile parameters
Parameter
Field
Length
Description
name
N/A
Specifies the name of the SIP Adaptor profile.
ruleId
N/A
The index number of this Rule within this Profile. Numeric;
range 1-32.
6–171
Profiles
Signaling
TABLE 6–29 SIP Adaptor Profile parameters (Continued)
Parameter
Field
Length
actionId
N/A
Description
The index number of this Action to perform within this Rule.
Actions are:
• from - The type of “from” information acted upon by this
Action. The possible values are:
type - This value displays the following options:
- globalVariable - Specify the global variable to take
this action on. Options are: sigportid srcipaddr
srcport undefined
- header - Action is applied to a message header.
Enter the from string of this action entry.
- messageBody - Action is applied to a message body.
The messageBody value options are: all
undefined
- parameter - Action is applied to a SIP parameter.
Enter the from string of this action entry for the
parameter.
- token - Specifies the token type to act upon by the
action. Options are: undefined uridisplayname
urihostname urihostport urischeme
uriusername
- value - Enter the value for the from string of this
action entry. Must be 1-128 characters.
- variable - The ID of the internal variable to apply
with this action. Options are: undefined var1
var2 var3 var4 var5 var6 var7 var8
var9 var10
value - The “from” string of this action entry.
• headerInfo - The type of Header information acted upon by
this Action. Options are: fieldValue headerValue
undefined
• headerPosition - The header position of add header
action. Options are: first last undefined
• operation - The action type of this SIP PDU manipulation
action entry. Options are: add
append
delete
modify
regappend
regdel
regpostdel
regpostsub
regpredel
regprepend
regpresub
regstore
regsub
store
undefined
• paramType - Details the Parameter type of this SIP PDU
Manipulation entry. Options are: generic undefined
uri userinfo
6–172
Signaling
Profiles
Parameter
actionId
(continued)
Field
Length
N/A
Description
• regexp - Specifies the regular expression string against
which comparison would be performed to find the matches.
Options are:
matchInstance - Apply the action associated with
a regular expression to a particular match instance.
Options are: all five four last one
three two
string - The regular expression text of this action
entry.
• to - The type of “to” information acted upon by this Action.
type - This value displays the following options:
Enter the to string of this action entry.
- messageBody - Action is applied to a message body.
Options are: all undefined
- parameter - Action is applied to a SIP parameter.
- token - Specifies the token type to act upon by the
action. Options are: undefined uridisplayname
urihostname urihostport urischeme
uriusername
- variable - The ID of the internal variable to apply
with this Action.
value - The “to” string of this action entry.
• type - The action type of this SIP PDU manipulation action
entry. Options are:
Options are:
- from - Action is applied to a from header.
Options are:
globalVariable - Specify the global
variable to take this action on. Options are:
sigportid srcipaddr srcport
undefined
header - Action is applied to a message
header. Options is:
value - The value to use for matching.
The from string of this action entry.
messageBody - Action is applied to a
message header. Options are: all
undefined
parameter - Action is applied to a
parameter. Options is:
6–173
Profiles
Signaling
Parameter
actionId
(continued)
Field
Length
N/A
Description
value - The value to use for matching. The
from string of this action entry.
token - Specifies the token type to act
upon by the action. Options are:
undefined uridisplayname
urihostname urihostport
urischeme uriusername
value - The value to use for matching.
variable - The ID of the internal variable
to apply with this Action. Options are:
undefined var1 var2 var3 var4
var5 var6 var7 var8 var9
var10
- headerInfo - The field details the header
information of SIP header manipulation.
Options are: fieldValue headerValue
undefined
- headerPosition - The header position of
add header action. Options are: first last
undefined
- operation - The action type of this SIP PDU
manipulation action entry. Options are: add
append
delete
modify
regappend regdel
regpostdel
regpostsub regpredel regprepend
regpresub regstore regsub store
undefined
- paramType - Details the parameter type of
this SIP PDU Manipulation entry. Options are:
generic undefined uri userinfo
- regexp - Specifies the regular expression
string against which comparison would be
performed to find the matches. Options are:
matchInstance - Apply the action
associated with a regular expression to a
particular match instance. Options are: all
five four last one three two
string - The regular expression text of this
action entry.
- to - The type of “to” information acted upon by
this Action. Options are:
- header - Action is applied to a message
header. Enter the to string of this action entry.
6–174
- messageBody - Action is applied to a
message body. Options are: all undefined
Signaling
Profiles
Parameter
actionId
(continued)
Field
Length
Description
N/A
- parameter - Action is applied to a SIP
parameter.
- token - Specifies the token type to act upon
by the action. Options are: undefined
uridisplayname urihostname
urihostport urischeme uriusername
- variable - The ID of the internal variable to
apply with this Action. Options are:
- variableRangeValue - Details the
variable range type of this SIP PDU
Manipulation entry. Options are:
undefined var1 var2 var3
var9 var10
- variableValue - Details the variable
type of this SIP PDU Manipulation entry.
Options are: undefined var1 var2
var8 var9 var10
applyMatchHd N/A
rRange
This value specifies the range of the filtered header
instances which are to be modified. The following is the
valid set of values for this field:
•
•
•
•
•
•
•
•
•
•
•
eight
five
four
last
nine
seven
six
ten
three
two
undefined
6–175
Profiles
Signaling
Parameter
Field
Length
applyMatchHea N/A
der
Description
This value specifies the matching header. The following
are the valid set of values for this field:
•
•
•
•
•
•
•
•
•
•
•
•
criterionId
N/A
all
eight
five
four
last
nine
one
seven
six
ten
three
two
Identifies the SIP PDU manipulation Criterion. Must be 1 10. Options are:
• globalVar - Specifies for which value of the global variable
the rule is applicable. The criteria must be present in global
variable rules. Options are:
- condition - The pattern matching condition of this
SIP PDU Manipulation criterion entry. Options are:
absent exist has-value not-equal-to
regex-match undefined
- globalVariableID - Details the global variable
type of this SIP PDU Manipulation entry. Options are:
sigportid srcipaddr srcport undefined
- regexp - Options are:
numMatch - Apply the criterion associated with a
number of match for a regular expression. Options
are: match noMatch
criterion entry.
- value - The criterion's value of this SIP PDU
Manipulation criterion entry.
• header - Specify the header for which the rule is applicable.
6–176
Signaling
Profiles
Parameter
Field
Length
criterionId( N/A
continued)
Description
- hdrInstance - Apply criteria on header instance
number. Options are: all eight five four
last nine one seven six ten three
two
- hdrRange - This is an optional upper range of header
instances. Options are: eight five four last
nine seven six ten three two
undefined
- name - The header name or parameter name of this
SIP PDU Manipulation criterion entry.
- numberOfInstances - This value specifies a
number of header instances for validation. Used when
a header criterion is the number of headers of a
particular type. Options are:
number - Criterion required to have total number of
header instance.
qualifier - The total number of headers
matching condition. Options are: equal
greater lessthan undefined
- regexp - Specifies the regular expression string
against which comparison would be performed to find
the matches. Options are:
are: match noMatch
criterion entry.
• message - Specifies whether the rule should apply for
requests/responses/both, method name and if applicable
response code/response code range. Options are:
- messageTypes - The SIP PDU manipulation
message types of this rule entry. Options are: all
request requestAll response
responseAll undefined
- methodTypes - The SIP PDU manipulation method
types of this rule entry. Options are: ack bye
cancel info invite message notify
options prack publish refer register
subscribe update
- statusCode - The status code of SIP PDU
and Proprietary.
All Rights
Reserved.
manipulation
rule.
Default
valueDoisnot0.distribute without permission.
6–177
Profiles
Signaling
Parameter
criterionId
(continued)
Field
Length
N/A
Description
- statusRange - The status code range of SIP PDU
manipulation rule. Default value is 0.
• messageBody - Specifies the message body for which the
rule is applicable. This criteria must be present in the message
body rules. Options are:
- messageBodyType - Details the message body type
of this SIP PDU Manipulation entry. Options are: all
undefined
are: match notmatch
criterion entry.
• parameter - Specifies the parameter for which the rule is
applicable. This criteria element must be present in Parameter
rules. Options are:
- name - The header name or parameter name of this
SIP PDU Manipulation criterion entry.
- paramType - Details the Parameter type of this SIP
PDU Manipulation entry. Options are: generic
undefined uri userinfo
number of match for a regular expression. Options are:
match notmatch
criterion entry.
6–178
Signaling
Profiles
Parameter
criterionId
(continued)
Field
Length
Description
N/A
• token - Specifies the token type to act upon by the action
are: match notmatch
criterion entry.
- tokenType - Details the token type of this SIP PDU
Manipulation entry. Options are: undefined
uridisplayname urihostname urihostport
urischeme uriusername
• variable - The ID of the internal variable to apply with this
Action.
are: match notmatch
criterion entry.
- variableID - Details the variable type of this SIP
PDU Manipulation entry. Options are: undefined
var1 var2 var3 var4 var5 var6 var7
var8 var9 var10
state
N/A
The administrative state of this SIP Pdu Manipulation entry.
displaylevel
1-64
commands.
6–179
Profiles
Signaling
Command Example
% show profiles signaling sipAdaptorProfile
sipAdaptorProfile Test {
state enabled;
rule 1 {
criterion 1 {
type parameter;
parameter {
condition exist;
paramType generic;
name
1;
value
1;
}
}
action 1 {
regexp {
string
1;
matchInstance all;
}
}
}
}
SIP Header Manipulation
Use the following commands to perform the message manipulation on Egress
INVITE Request-URI user name part. After the manipulation, +1 is prefixed to
user name part of Request-URI in Egress INVITE.
% set profiles signaling sipAdaptorProfile SMM_01
% set profiles signaling sipAdaptorProfile SMM_01 rule 1
criterion 1 type message message condition exist
messageTypes request methodTypes invite
criterion 2 type header header condition exist name
request-line
criterion 2 type header header numberOfInstances number 1
qualifier equal
6–180
Signaling
Profiles
criterion 3 type token token condition exist tokenType
uriusername
action 1 type token
action 1 operation regprepend
action 1 regexp string [^/d]
action 1 to token uriusername
action 1 from value +1
set profiles signaling sipAdaptorProfile SMM_01 state enable
To view the configured profile:
Show profiles signaling sipAdaptorProfile SMM_01
After the Profile is created, configure it on Egress trunk group under
outputAdapterprofile:
set addressContext a1 zone EXTERNAL sipTrunkGroup BLR_EXT
signaling messageManipulation outputAdapterProfile SMM_01
SIP/CPC Cause Code Mapping Profile
The Causemap profiles, sipToCpcCauseMap and cpcToSipCauseMap, provide
customized tables on the SBC 5x00 to map cause codes between SIP and Q850
cause codes. The custom mappings can be selected on a per route basis, on
egress trunks, as well as on a per call basis, on ingress trunks, through the IP
Signaling Profile. Four pre-configured base profiles are available to either use as
is, or to build upon for SIP to CPC mapping:
•
•
•
•
DefaultSipCpc - recommended to achieve backwards compatibility. Index
is 1.
DefaultQ1912SipCpc - based on Q1912.5. Index is 2.
DefaultRFC3398SipCpc - based on RFC 3398. Index is 3.
DefaultTS29163SipCpc - based on 3GPP TS 29.163. Index is 4.
The four corresponding pre-configured profiles for CPC to SIP mapping are:
•
•
•
DefaultCpcSip - recommended to achieve backwards compatibility. Index
is 1.
DefaultQ1912CpcSip - based on Q1912.5. Index is 2.
DefaultRFC3398CpcSip - based on RFC 3398. Index is 3.
6–181
Profiles
•
Signaling
DefaultTS29163CpcSip - based on 3GPP TS 29.163. Index is 4.
In the case of both SIP to CPC and CPC to SIP there is an additional mapping
corresponding to index = 0. Each corresponds to a fixed mapping implemented
directly in the SBC 5x00 software. Profiles corresponding to indices 0 - 4 may not
be altered under any circumstances. However, when you create a new profile, it is
populated using a pre-configured profile that you specify and thereafter you may
add, delete, and modify entries. Up to 12 new profiles may be created. Each
profile has a unique index (an integer in the range 5-16) associated with it. The
base profiles take indices 1-4. The index of the desired profile is configured on the
SBC 5x00 on the ingress and egress IP Signaling profiles.
After creating a new profile:
•
•
Use set to change the mapping of an existing cause code and to add a
cause code that doesn’t exist.
Use delete to remove a cause code mapping. (This might be necessary to
invoke the special case handling that is described below.)
The following special case handling is performed for cause codes that are not
present in the active Causemap profiles:
•
•
•
Cause code 22 (“number changed”) - If this code is received, then if there are
diagnostics in the REL with the new called party number, the REL will be
mapped to a 301 and the new called party number will go in the contact
header, otherwise it will be mapped into a 410. This is the default behavior for
profiles based upon DefaultRFC3398SipCpc because cause code 22 is
absent from that profile.
Cause code 21 (“call rejected”) - If this code is received, and location is set to
“user”, then 603 is sent, otherwise 403 is sent. This is the default behavior for
profiles based upon DefaultRFC3398SipCpc because cause code 21 is
absent from that profile.
Cause code 34 (“no circuit available”) - If this code is received, then if there
are diagnostics in the REL that indicate CCBS possible, 486 is sent,
otherwise 480 is sent. This is the default behavior for profiles based upon
DefaultQ1912SipCpc because cause code 34 is absent from that profile.
This behavior is achieved by deleting the relevant cause code from the new
profile.
CPC to SIP Cause Map Profile
The index number will be used by the SBC 5x00 to locate the corresponding CPCto-SIP cause mapping profile on the SBC 5x00. The profile maps internal CPC
(Call Processing Component) cause codes to SIP status codes.
Command Syntax
% set profiles signaling sipCauseCodeMapping
cpcToSipCauseMapProfile <cpcToSipCauseMapProfile>
baseProfile <baseProfile> causeMap <causeMap1>
includeq850Reason <q850Reason>
6–182
Signaling
Profiles
unrecAction <unrecAction>
% show profiles signaling sipCauseCodeMapping
cpcToSipCauseMapProfile <cpcToSipCauseMapProfile>
sipToCpcCauseMapProfile <sipToCpcCauseMapProfile>
% delete profiles signaling sipCauseCodeMapping
<cpcToSipCauseMapProfile>
Command Parameters
TABLE 6–30 CPC SIP Cause Code Mapping profile parameters
Parameter
Field
Length
cpcToSipCause 1-23
MapProfile
Description
The name of a
cpcToSipCauseMapProfilesipToCpcCauseMapProfil
e. This table contains information about each SIP-to-CPC Cause
Mapping Profile on the node. The default values are:
•
•
•
•
baseProfile
1-23
defaultSipCpc
defaultQ1912SipCpc
defaultRFC3398SipCpc
The name of the default SIP-to-CPC Mapping Profile on
which to base this new profile.
•
•
•
•
defaultCpcSip
defaultQ1912CpcSip
defaultRfc3398CpcSip
defaultTs29163CpcSip
The base profiles cannot be modified. The base profile that
you designate will be copied to the profile that you create.
Additions, modifications, and deletions may subsequently
be applied to the new profile through the set command.
6–183
Profiles
Parameter
Field
Length
causeMap
N/A
Signaling
Description
Specifies the SIP-to-CPC cause mapping values. Enter
cause map value between 1-255 and specify the following
reasons:
q850Reason - Q.850 reason for a given CPC cause value.
Specifies the Reason Header Q.850 value to include in the
SIP message (when the INCLUDEQ850REASON
parameter is enabled). Also indicates the cause code value
to include in MIME encapsulated ISUP, if the call uses SIPI signaling. Must be 0- 127; default is 0.
A value of 0 indicates that the Reason Header Q.850 value
should be equal to the predefined ISUP mapping
associated with the CPCCAUSE value. If no predefined
ISUP mapping exists (as for internal cause codes 151159), the ISDN mapping is used.
• sipCause - SIP Cause value for a given CPC cause value.
The value must be in the range of 300-606.
NOTE
This parameter applies to
CAUSEMAP CPC_TO_SIP
PROFILES only.
includeQ850R N/A
eason
Specifies whether the SIP error messages associated with
this profile will include a Reason Header Q.850 value taken
from the q850Reason parameter.
• enabled - SIP error messages associated with this profile will
include a Reason Header Q.850 value taken from the
q850Reason parameter.
• disabled (default) - the SIP error messages will not include
a q850Reason value.
Specifies the SIP cause value to use when an
unrecognized ISUP cause value is received (a value that is
not present in the CPC_TO_SIP CAUSEPROFILE):
unrecAction
• q1912Procedure - Use the default value of the ISUP class
of the unrecognized cause code and map that value to the SIP
cause value, the default in defaultQ1912CpcSip.
• rfc3398Procedure - Use SIP 500 message (SERVER
INTERNAL ERROR), the default in
defaultRFC3398CpcSip.
• ts29163Procedure
displaylevel
1-64
commands.
Command Example
6–184
Signaling
Profiles
sipToCpcCauseMapProfile
sipToCpcCauseMapProfile defaultSipCpc {
causeMap 400 {
cpcCause 41;
}
cancelCause 16;
locBye
networkBeyondPoint;
locCancel
networkBeyondPoint;
loc3xx
networkBeyondPoint;
loc4xx
networkBeyondPoint;
loc5xx
networkBeyondPoint;
loc6xx
networkBeyondPoint;
}
cpcToSipCauseMapProfile
cpcToSipCauseMapProfile defaultCpcSip {
causeMap 1 {
sipCause
344;
q850Reason 34;
}
}
baseProfile
defaultCpcSip;
unrecAction
rfc3398Procedure;
includeQ850Reason enabled;
}
SIP to CPC Cause Code Mapping Profile
This profile provides information about each SIP-to-CPC Cause Mapping Profile
on the node.
Command Syntax
% set profiles signaling sipCauseCodeMapping
loc3xx <locNxx>
loc4xx <locNxx>
6–185
Profiles
Signaling
loc5xx <locNxx>
loc6xx <locNxx>
locBye <locBye>
locCancel <locCancel>
cancelCause <cancelCause>
baseProfile <baseProfile>
causeMap <causeMap> cpcCause <cpcCause>
% delete profiles signaling sipCauseCodeMapping
<sipToCpcCauseMapProfile>
Command Parameters
TABLE 6–31 SIP to CPC Cause Code Mapping profile parameters
Parameter
Field
Length
sipToCpcCause 1-23
MapProfile
Description
The name of a sipToCpcCauseMapProfile. This table
contains information about each SIP-to-CPC Cause Mapping
Profile on the node. The default values are:
•
•
•
•
baseProfile
1-23
defaultQ1912SipCpc
defaultSipCpc
The name of the default SIP-to-CPC Mapping Profile on
which to base this new profile.
•
•
•
•
defaultQ1912SipCpc
defaultSipCpc defaultTs29163SipCpc
The base profiles cannot be modified. The base profile that
you designate will be copied to the profile that you create.
Additions, modifications, and deletions may subsequently
be applied to the new profile through the set command.
cancelCause
6–186
N/A
The Q850 cause value that the SIP CANCEL message
should generate. RFC3398 specifies 16 (normal clearing),
whereas Q1912.5 specifies 31 (normal unspecified). The
respective default profiles contain these mappings but this
provides a user override to the default mapping. Must be 1127.
Signaling
Parameter
Field
Length
causeMap
N/A
Profiles
Description
Specifies the SIP-to-CPC cause mapping values. The
400
413
483
503
401 402 403
414 415 416
484 485 486
504 505 513
404
420
487
580
405 406 407 408 410
421 423 480 481 482
488 493 500 501 502
600 603 604 606
cpcCause
N/A
CPC Cause value for a given SIP cause value. Must be 1127. Default value is 127.
locNxx
N/A
Specifies the location value to use for the SS7 REL
message when a SIP 3XX, 4XX, 5XX, or 6XX message is
received:
• user - default in DefaultRFC3398SipCpc for SIP 6XX
messages.
• localPrivateNetwork
• localLocalNetwork - default in defaultRFC3398SipCpc
for SIP 4XX and 5XX messages.
• transitNetwork
• remoteLocalNetwork
• remotePrivateNetwork
• localInterfaceControlledByThisSigLink
• internationalNetwork
• networkBeyondPoint - default in defaultQ1912SipCpc
for SIP 4XX, 5XX, and 6XX.
• privateBranchExchange
locBye
N/A
message when a SIP BYE message is received:
•
•
•
•
•
•
•
•
•
user
localPrivateNetwork
localLocalNetwork
transitNetwork
remoteLocalNetwork
remotePrivateNetwork
localInterfaceControlledByThisSigLink
internationalNetwork
networkBeyondPoint - default in defaultQ1912SipCpc
and in defaultRFC3398SipCpc.
6–187
Profiles
Parameter
Field
Length
locCancel
N/A
Signaling
Description
message when a SIP CANCEL message is received:
•
•
•
•
•
•
•
•
•
user
localPrivateNetwork
localLocalNetwork
transitNetwork
remoteLocalNetwork
remotePrivateNetwork
localInterfaceControlledByThisSigLink
internationalNetwork
networkBeyondPoint - default in defaultQ1912SipCpc
and in defaultRFC3398SipCpc.
displaylevel
6–188
1-64
commands.
SIP CAC Profile
Profiles
SIP CAC Profile
This object creates and configures a call admission control (CAC) profile providing
the ability for each SIP registered or static endpoint to have individualized limits on
the number of active calls and the call rate. A limit on active calls (callLimit) is
applied to calls in either the ingress or egress direction, whereas policing controls
(callIngressRate, callEgressRate, callIngressBurstSize and
callEgressBurstSize) apply to ingress and egress calls separately.
Command Syntax
// Mandatory parameters to configure a SIP CAC profile
% set profiles sipCacProfile <sipCacProfile>
callEgressBurstSize <callEgressBurstSize>
callEgressRate <callEgressRate>
callEgressRatePeriod <callEgressRatePeriod>
callIngressBurstSize <callIngressBurstSize>
callIngressRate <callIngressRate>
callIngressRatePeriod <callIngressRatePeriod>
callLimit <callLimit>
emergencyOversubscription <emergencyOversubscription>
state <state>
% show profiles sipCacProfile <sipCacProfile>
% delete profiles sipCacProfile <sipCacProfile>
6–189
Profiles
SIP CAC Profile
Command Parameters
TABLE 6–32 SIP CAC Profile Parameters
Parameter
Field
Length
sipCacProfile
1-23
Specifies the name of the SIP Call Admission
Control (CAC) profile you are configuring.
Must be 1-23 characters.
callEgressBurstSize
N/A
Specifies the maximum call burst size for
calls to a registered endpoint or peer. Must be
1-500 (calls); default value is 1.
callEgressRate
N/A
Specifies the maximum egress call rate in
calls per period. Must be 1-500 or enter
unlimited.
callEgressRatePeriod
N/A
Specifies the period in seconds over which
egress call rate applies. Must be 1-10; default
value is 1.
callIngressBurstSize
N/A
Specifies the maximum call burst size from a
peer or registered endpoint. Must be 1-500;
default value is 1.
callIngressRate
N/A
Specifies the maximum call arrival rate from a
peer or registered endpoint per
callIngressRatePeriod. Must be 1-500
(calls) or unlimited; default is 0. A value of 0
indicates that call rate policing is not
applicable.
callIngressRatePerio
d
N/A
Specifies the period in seconds over which
the callIngressRate applies. Must be 1-10
seconds; default value is 1.
callLimit
N/A
Specifies the maximum number of active calls
to and from any registered endpoint or peer
(the total number of ingress and egress calls).
Must be 0-30000 or unlimited.
emergencyOversubscri
ption
N/A
Oversubscription of calls (as a percentage)
allowed for emergency calls. Must be 0-1000.
Default value is 0.
state
N/A
Specifies the administrative state of this
SIP CAC Profile. The possible values are:
Description
• disabled (default)
• enabled
displaylevel
6–190
1-64
To display different levels of output
SIP CAC Profile
Profiles
Command Example
% show profiles sipCacProfile SIPCAC_TEST
state
enabled;
callIngressRate
78;
callIngressRatePeriod
4;
callIngressBurstSize
342;
callEgressRate
43;
callEgressRatePeriod
3;
callEgressBurstSize
45;
callLimit
4567;
emergencyOversubscription
24;
6–191
Profiles
System Profile
System Profile
The System profile supports the following profiles which are explained in the
subsequent sections:
•
•
•
"Coredump Profile" on page 6–192
"IP Policing Alarm Profile" on page 6–193
"Overload Profile" on page 6–201
Coredump Profile
The coredump profiles specifies limits on the maximum number and total size of
coredump files, and the conditions under which coredumps will be generated.
Command Syntax
// Mandatory parameters to configure a Coredump profile
% set profiles system coredumpProfile <coredumpProfile>
coredumpCountLimit <coredumpCountLimit>
coredumpLevel <coredumpLevel>
coredumpSpaceLimit <coredumpSpaceLimit>
// Non-mandatory parameters that can be used to configure a Coredump profile
% show profiles system coredumpProfile <coredumpProfile>
coredumpCountLimit <coredumpCountLimit>
coredumpLevel <coredumpLevel>
coredumpSpaceLimit <coredumpSpaceLimit>
% delete profiles system coredumpProfile <coredumpProfile>
6–192
System Profile
Profiles
Command Parameters
TABLE 6–33 Coredump Profile parameters
Parameter
Field
Length
Description
coredumpProf 1-23
ile
Specifies the name of the Coredump profile.
coredumpCoun N/A
tLimit
Specifies the number of coredumps allowed on a hard disk
per process. Must be 1-10; default value is 3.
coredumpLeve N/A
l
Specifies the state of the coredump:
coredumpSpac N/A
eLimit
displaylevel
1-64
• disabled - The state of the Coredump profile is disabled.
• normal - The state of the Coredump profile is normal.
• sensitive - The state of the Coredump profile is sensitive.
Specifies the coredump disk space limit per server (in
GigaBytes). Must be 1-20; default value is 6.
commands.
Command Example
% show profiles system coredumpProfile coredumpProfile1
coredumpLevel normal;
coredumpSpaceLimit 12;
coredumpCountLimit 4;
IP Policing Alarm Profile
The IP Policing alarm profile specifies the parameters that determine when alarms
associated with IP policing should be generated and when the alarms should be
cleared.
Command Syntax
// Mandatory parameters to configure an IP policing alarm profile
% set profiles system ipPolicingAlarmProfile
defaultSystemMajor <defaultSystemMajor>
defaultSystemMinor <defaultSystemMinor>
6–193
Profiles
System Profile
aclClearDuration <aclClearDuration>
aclClearThreshold <aclClearThreshold>
aclSetDuration <aclSetDuration>
aclSetThreshold <aclSetThreshold>
aggregateClearDuration <aggregateClearDuration>
aggregateClearThreshold <aggregateClearThreshold>
aggregateSetDuration <aggregateSetDuration>
aggregateSetThreshold <aggregateSetThreshold>
arpClearDuration <arpClearDuration>
arpClearThreshold <arpClearThreshold>
arpSetDuration <arpSetDuration>
arpSetThreshold <arpSetThreshold>
badEthernetIpHeaderClearDuration
<badEthernetIpHeaderClearDuration>
badEthernetIpHeaderClearThreshold
<badEthernetIpHeaderClearDuration>
badEthernetIpHeaderSetDuration
<badEthernetIpHeaderSetDuration>
badEthernetIpHeaderSetThreshold
<badEthernetIpHeaderSetThreshold>
discardRuleClearDuration <discardRuleClearDuration>
discardRuleClearThreshold <discardRuleClearThreshold>
discardRuleSetDuration <discardRuleSetDuration>
discardRuleSetThreshold <discardRuleSetThreshold>
index <index>
ipSecDecryptClearDuration <ipSecDecryptClearDuration>
ipSecDecryptClearThreshold <ipSecDecryptClearThreshold>
ipSecDecryptSetDuration <ipSecDecryptSetDuration>
ipSecDecryptSetThreshold <ipSecDecryptSetThreshold>
mediaClearDuration <mediaClearDuration>
mediaClearThreshold <mediaClearThreshold>
mediaSetDuration <mediaSetDuration>
mediaSetThreshold <mediaSetThreshold>
rogueMediaClearDuration <rogueMediaClearDuration>
rogueMediaClearThreshold <rogueMediaClearThreshold>
rogueMediaSetDuration <rogueMediaSetDuration>
rogueMediaSetThreshold <rogueMediaSetThreshold>
state <state>
6–194
System Profile
Profiles
uFlowClearDuration <uFlowClearDuration>
uFlowClearThreshold <uFlowClearThreshold
uFlowSetDuration <uFlowSetDuration>
uFlowSetThreshold <uFlowSetThreshold>
// Non-mandatory parameters that can be used to configure an IP policing alarm
profile
% show profiles system ipPolicingAlarmProfile
% delete profiles system ipPolicingAlarmProfile
<defaultSystemMinor >
% delete profiles system ipPolicingAlarmProfile
<defaultSystemMinor>
Command Parameters
TABLE 6–34 IP Policing Alarm Profile parameters
Parameter
Field
Length
Description
aclClearDura N/A
tion
Specifies the duration (in seconds) that the access control
list policer discard rate (in pkts/sec) must be at or below its
clear threshold before an alarm is cleared. The default
value is 3.
aclClearThre N/A
shold
Specifies the threshold for the access control list policer
discard rate (in pkts/sec) which may clear an alarm. The
aclSetDurati N/A
on
Specifies the duration (in seconds) that the access control
list policer discard rate (in pkts/sec) must be at or above its
set threshold before an alarm is set. The default value is 3.
aclSetThresh N/A
old
Specifies the threshold for the access control list policer
discard rate (in pkts/sec) which may set an alarm. The
6–195
Profiles
System Profile
Parameter
Field
Length
Description
aggregateCle N/A
arDuration
Specifies the duration (in seconds) that the aggregate
policer discard rate (in pkts/sec) must be at or below its
value is 3.
aggregateCle N/A
arThreshold
Specifies the threshold for the aggregate policer discard
rate (in pkts/sec) which may clear an alarm. The default
value is 20.
aggregateSet N/A
Duration
Specifies the duration (in seconds) that the aggregate
policer discard rate (in pkts/sec) must be at or above its set
threshold before an alarm is set. The default value is 3.
aggregateSet N/A
Threshold
Specifies the threshold for the aggregate policer discard
rate (in pkts/sec) which may set an alarm. The default
value is 100.
arpClearDura N/A
tion
Specifies the duration (in seconds) that the ARP policer
discard rate (in pkts/sec) must be at or below its clear
threshold before an alarm is cleared. The default value is 3.
arpClearThre N/A
shold
Specifies the threshold for the ARP policer discard rate (in
pkts/sec) which may clear an alarm. The default value is
20.
arpSetDurati N/A
on
Specifies the duration (in seconds) that the ARP policer
discard rate (in pkts/sec) must be at or above its set
arpSetThresh N/A
old
Specifies the duration (in seconds) that the bad Ethernet IP
header policer discard rate (in pkts/sec) must be at or
below its clear threshold before an alarm is cleared. The
badEthernetI N/A
pHeaderClear
Duration
Specifies the duration (in seconds) that the bad Ethernet IP
below its clear threshold before an alarm is cleared. The
default value is 3.
badEthernetI N/A
pHeaderClear
Threshold
Specifies the threshold for the bad Ethernet IP header
policer discard rate (in pkts/sec) which may clear an alarm.
The default value is 20.
badEthernetI N/A
pHeaderSetDu
ration
Specifies the duration (in seconds) that the bad ethernet IP
above its set threshold before an alarm is set. The default
value is 3.
badEthernetI N/A
pHeaderSetTh
reshold
Specifies the threshold for the bad ethernet IP header
policer discard rate (in pkts/sec) which may set an alarm.
The default value is 100.
discardRuleC N/A
learDuration
Specifies the duration (in seconds) that the discard rule
6–196
System Profile
Profiles
Parameter
Field
Length
Description
discardRuleC N/A
learThreshol
d
Specifies the threshold for the discard rule discard rate (in
10.
discardRuleS N/A
etDuration
Specifies the duration (in seconds) that the discard rule
discardRuleS N/A
etThreshold
Specifies the threshold for the discard rule discard rate (in
pkts/sec) which may set an alarm. The default value is 20.
index
N/A
Identifies the Policer Discard Rate profile. The default
value is 1.
ipSecDecrypt N/A
ClearDuratio
n
Specifies the duration (in seconds) that the IPSEC decrypt
value is 3.
ipSecDecrypt N/A
ClearThresho
ld
Specifies the threshold for the IPSEC decrypt policer
discard rate (in pkts/sec) which may clear an alarm. The
ipSecDecrypt N/A
SetDuration
Specifies the duration (in seconds) that the IPSEC decrypt
ipSecDecrypt N/A
SetThreshold
Specifies the threshold for the IPSEC decrypt policer
discard rate (in pkts/sec) which may set an alarm. The
mediaClearDu N/A
ration
Specifies the duration (in seconds) that the media policer
mediaClearTh N/A
reshold
Specifies the threshold for the media policer discard rate (in
20.
mediaSetDura N/A
tion
Specifies the duration (in seconds) that the media policer
mediaSetThre N/A
shold
Specifies the threshold for the media policer discard rate (in
pkts/sec) which may set an alarm. The default value is 100.
rogueMediaCl N/A
earDuration
Specifies the duration (in seconds) that the rogue media
value is 3.
rogueMediaCl N/A
earThreshold
Specifies the threshold for the rogue media policer discard
value is 20.
6–197
Profiles
System Profile
Parameter
Field
Length
Description
rogueMediaSe N/A
tDuration
Specifies the duration (in seconds) that the rogue media
rogueMediaSe N/A
tThreshold
Specifies the threshold for the rogue media policer discard
value is 100.
N/A
state
Specifies the administrative state of the profile. The
• disabled
• enabled
uFlowClearDu N/A
ration
Specifies the duration (in seconds) that the micro flow
value is 3.
uFlowClearTh N/A
reshold
Specifies the threshold for the micro flow policer discard
value is 20.
uFlowSetDura N/A
tion
Specifies the duration (in seconds) that the micro flow
uFlowSetThre N/A
shold
Specifies the threshold for the micro flow policer discard
value is 100.
displaylevel
1-64
commands.
Command Example
defaultSystemMajor
defaultSystemMajor
index
1;
state
enabled;
100;
badEthernetIpHeaderClearThreshold 20;
6–198
3;
3;
arpSetThreshold
100;
arpClearThreshold
20;
System Profile
Profiles
arpSetDuration
3;
arpClearDuration
3;
uFlowSetThreshold
100;
uFlowClearThreshold
20;
uFlowSetDuration
3;
uFlowClearDuration
3;
aclSetThreshold
100;
aclClearThreshold
20;
aclSetDuration
3;
aclClearDuration
3;
aggregateSetThreshold
100;
aggregateClearThreshold
20;
aggregateSetDuration
3;
aggregateClearDuration
3;
ipSecDecryptSetThreshold
100;
ipSecDecryptClearThreshold
20;
ipSecDecryptSetDuration
3;
ipSecDecryptClearDuration
3;
mediaSetThreshold
100;
mediaClearThreshold
20;
mediaSetDuration
3;
mediaClearDuration
3;
rogueMediaSetThreshold
100;
rogueMediaClearThreshold
20;
rogueMediaSetDuration
3;
rogueMediaClearDuration
3;
discardRuleSetThreshold
20;
discardRuleClearThreshold
10;
discardRuleSetDuration
3;
discardRuleClearDuration
3;
defaultSystemMinor
defaultSystemMinor
index
1;
state
enabled;
100;
badEthernetIpHeaderClearThreshold 20;
6–199
Profiles
6–200
System Profile
3;
3;
arpSetThreshold
100;
arpClearThreshold
20;
arpSetDuration
3;
arpClearDuration
3;
uFlowSetThreshold
20;
uFlowClearThreshold
10;
uFlowSetDuration
3;
uFlowClearDuration
3;
aclSetThreshold
100;
aclClearThreshold
20;
aclSetDuration
3;
aclClearDuration
3;
aggregateSetThreshold
100;
aggregateClearThreshold
20;
aggregateSetDuration
3;
aggregateClearDuration
3;
ipSecDecryptSetThreshold
100;
ipSecDecryptClearThreshold
20;
ipSecDecryptSetDuration
3;
ipSecDecryptClearDuration
3;
mediaSetThreshold
100;
mediaClearThreshold
20;
mediaSetDuration
3;
mediaClearDuration
3;
rogueMediaSetThreshold
100;
rogueMediaClearThreshold
20;
rogueMediaSetDuration
3;
rogueMediaClearDuration
3;
discardRuleSetThreshold
20;
discardRuleClearThreshold
10;
discardRuleSetDuration
3;
discardRuleClearDuration
3;
System Profile
Profiles
Overload Profile
The Overload Profile specifies a set of congestion thresholds, congestion
durations, and overload controls. When a particular threshold is exceeded for a
particular duration, the congestion level may be raised to a higher level. Then, the
overload control may be applied to help alleviate the congestion. The profile also
specifies clear congestion thresholds and durations. These values establish the
criteria for returning to the previous congestion level. These values require that
the overload conditions fall below their configured clear threshold values for a
specific duration of time, in order to return to the previous congestion level. These
minimum clear durations prevent thrashing in and out of congestion levels.
You may assign an Overload Profile to the system (and apply it throughout the
SBC 5x00). You may specify and manage the following congestion criteria
through this facility:
•
•
CPU utilization
Memory utilization
Default Overload Profiles are automatically created for system congestion levels
1-3. These profiles are named as:
•
defaultMC1
•
defaultMC2
•
defaultMC3
You must disable an Overload Profile in order to change its configuration. Then,
when you enable the profile, you cause all the parameter values to be validated.
Once validated, these values are applied to the (system) congestion level that
references the profile. When you disable a profile, the SBC 5x00 application
continues to utilize the previous values of the profile for congestion control
processing. When you make a change in this manner, the system congestion
level is cleared if the Overload Profile was being referenced. Standby modules
also perform congestion processing but you cannot configure the module settings.
Command Syntax
% set profiles system overloadProfile
<defaultMC1|defaultMC2|defaultMC3>
clearDuration <clearDuration>
clearThreshold <clearThreshold>
setDuration <setDuration>
setThreshold <setThreshold>
state <state>
staticMode <staticMode>
<defaultMC1|defaultMC2|defaultMC3> clearDuration
<clearDuration>
6–201
Profiles
System Profile
cpu <cpu>
memory <memory>
<defaultMC1|defaultMC2|defaultMC3> clearThreshold
<clearThreshold>
cpu <cpu1>
memory <memory1>
<defaultMC1|defaultMC2|defaultMC3> setDuration
<setDuration>
cpu <cpu2>
memory <memory2>
<defaultMC1|defaultMC2|defaultMC3> setThreshold
<setThreshold>
cpu <cpu3>
memory <memory3>
% show profiles system overloadProfile
clearDuration
cpu <cpu>
memory <memory>
clearThreshold
cpu <cpu>
memory <memory>
setDuration
cpu <cpu>
memory <memory>
setThreshold
6–202
System Profile
Profiles
cpu <cpu>
memory <memory>
staticMode
acceptPercentage <acceptPercentage>
% delete profiles system overloadProfile <overloadProfile>
Command Parameters
TABLE 6–35 Overload Profile parameters
Parameter
Field
Length
Description
overloadProf 1-23
ile
Specifies an alphanumeric name that you assign to the
Overload Profile that is being created or configured.
clearDuratio N/A
n
Specifies the set threshold value for a monitored resource.
• cpu -The length of time (in seconds) that the CPU utilization
percentage must be below its clear threshold before the
congestion level is cleared. A value of zero clears the
congestion level immediately. Must be 0-65535 (seconds).
Default value is 10 for .
• memory - The length of time (in seconds) that the memory (or
ICM) utilization percentage must be above its set threshold
before the congestion level is set or cleared. A value of 0
clears the congestion level immediately. Must be 0-65535
(seconds);
clearThresho N/A
ld
• cpu1 - The CPU utilization percentage threshold at which a
congestion level may be set or cleared. This clear threshold
must be less than or equal to the set threshold. Must be 0-100
(percent); default value is 85.
• memory1 - The memory utilization percentage threshold at
which a congestion level may be set or cleared. Must be 0-100
(percent); default value is 54.
6–203
Profiles
System Profile
TABLE 6–35 Overload Profile parameters
Parameter
Field
Length
Description
setDuration
N/A
• cpu2 - The length of time (in seconds) that the CPU utilization
percentage must be above its set threshold before the
congestion level is set. Must be 0-65535 (seconds); default
value is 10. A value of zero sets the congestion level
immediately.
• memory2 - The length of time (in seconds) that the memory
(or ICM) utilization percentage must be above its set threshold
before the congestion level is set. Must be 0-65535 (second);
default value is 10. A value of zero sets the congestion level
immediately.
setThreshold N/A
• cpu3 - The CPU utilization percentage threshold at which the
congestion level associated with this Overload profile may be
set. Must be 0-100 (percent); default value is 90. A value of 0
disables CPU utilization as a criterion for congestion.
• memory3 - The memory utilization percentage threshold at
which a congestion level associated with this Overload profile
may be set. The memory (or ICM) utilization percentage
threshold at which a congestion level may be set or cleared.
Must be 0-100 (percent); default value is 80. A value of 0
disables memory utilization as a criterion for congestion.
state
N/A
Specifies the administrative state of the Overload profile.
• disabled (default) - You must assign the Overload Profile
into this state to change the value of any of its parameters. In
this state, congestion processing continues to use the
previous values of the profile.
• enabled - You must assign the Overload Profile into this
state to apply a congestion level (system) that references this
profile. Assigning it into this state will cause all parameter
values to be validated.
staticMode
N/A
• acceptPercentage - The rate at which calls will be
accepted in this congestion level. Must be 0-100 (percent);
A value of 0 rejects all calls. A value of 100 accepts all
calls. When the system congestion is level defaultMC3,
the value of this parameter is effectively 0, causing all calls
to be rejected.
displaylevel
6–204
1-64
commands.
System Profile
Profiles
Command Example
% show profiles system overloadProfile Test123
state enabled;
setThreshold
{
cpu
85;
memory 90;
}
clearThreshold
{
cpu
80;
memory 85;
}
setDuration
{
cpu
10;
memory 10;
}
clearDuration
{
cpu
10;
memory 10;
}
staticMode
{
acceptPercentage 85;
}
6–205
Profiles
6–206
System Profile
CHAPTER 7
System
This chapter describes how to configure and manage server, ports, interface
groups, static routes and security MIBs of the system object. Topics include:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
"Admin" on page 7–2
"Congestion" on page 7–8
"DSP Packet Assembler Disassembler (PAD) Resources" on page 7–14
"Ethernet Port" on page 7–22
"Interval Statistics" on page 7–24
“Logical Management IP Interface” on page 7-26
"Media" on page 7–28
"Media Profile" on page 7–31
"Management IP Interface Group" on page 7–34
"Management Static Route" on page 7–42
"NTP Services Management" on page 7–44
"Policy Server" on page 7–48
"Security Management" on page 7–58
"Server Administration" on page 7–62
7–1
System
Admin
Admin
The admin object allows you to configure the system administration related
parameters in the SBC 5x00 system. You can configure audit log state, system
location, IP version used, and other parameters.
Command Syntax
// Manadatory parameters required to configure an Admin.
% set system admin <admin>
auditLogState <auditLogState>
cliIdleTimeout <cliIdleTimeout>
contact <contact>
location <location>
managementIpVersion <managementIpVersion>
standbyServerState <standbyServerState>
utilMonitorStatsInterval <utilMonitorStatsInterval>
utilMonitorStatsNumOfPastInterval
<utilMonitorStatsNumOfPastInterval>
// Non-manadatory parameters that can be used to configure or display the Admin
status.
% show system admin <admin>
auditLogState <auditLogState>
cliIdleTimeout <cliIdleTimeout>
contact <contact>
location <location>
managementIpVersion <managementIpVersion>
standbyServerState <standbyServerState>
utilMonitorStatsInterval <utilMonitorStatsInterval>
utilMonitorStatsNumOfPastInterval
<utilMonitorStatsNumOfPastInterval>
% delete system admin <admin>
% request system admin systemname
commitSoftwareUpgrade <commitSoftwareUpgrade>
7–2
Admin
System
identify <identify>
loadConfig <loadConfig>
removeSavedConfig <removeSavedConfig>
removeTransferredFile <removeTransferredFile>
restart <restart>
revertSoftwareUpgrade <revertSoftwareUpgrade>
saveConfig <saveConfig>
softReset <softReset>
stopFileTransfer <stopFileTransfer>
switchover <switchover>
transferFile <transferFile>
% request system congestion
% request system ipPolicing resetOffendersList name
aclOffendersList
arpOffendersList
mediaOffendersList
uFlowOffendersList
Command Parameters
TABLE 7–1
Admin Parameters
Parameter
Field
Length
Description
NOTE
Mandatory parameter descriptions for an Admin.
admin
N/A
auditLogState N/A
Specifies the name of the system.
Specifies the management audit log state. Options are:
• disabled (default) - in this state the audit log is inactive.
• enabled - in this state the audit log is active.
7–3
System
TABLE 7–1
Admin
Admin Parameters (Continued)
Field
Length
Parameter
cliIdleTimeou 0-120
t
Description
Specifies the CLI idle timeout in minutes. The number of
minutes to wait for CLI session to timeout. Default is 30. If
you set CLI idle timeout to 0, the timeout value is infinity.
contact
N/A
Specifies the contact information of the system.
location
N/A
Specifies the physical location of the system.
managementIpV N/A
ersion
Specifies the IP version used by the management
application.
• IPv4 - To support 32-bit IP address in dotted decimal form (for
example 128.127.50.224).
• IPv6 - To support eight 16-bit IP address in hexadecimal
values separated by colons (for example
1280:1276:3350:2224:2222:3333:8888:1245).
standbyServer N/A
State
Specifies the whether to enable or disable standby server if
the active server fails.
• disabled (default) - The standby server is inactive.
• enabled - The standby server is active.
utilMonitorSt N/A
atsInterval
Specifies the time interval for system resource monitoring
statistics. This parameter defines the range of timer interval
in minutes that can be used by the configuration
management for measuring the statistics of certain
resources. Default value is 15 minutes.
utilMonitorSt N/A
atsNumOfPastI
nterval
Specifies the number of past intervals saved for system
resource monitoring statistics. This parameter defines the
range of past interval that can be configured for retrieving
the statistics data. Default value is 4.
NOTE
Non-mandatory parameter descriptions for an Admin.
displaylevel
1-64
commitSoftwar N/A
eUpgrade
Displays the different levels of output information in show
commands.
Commits software upgrade.
identify
N/A
Turns on the locator LED of servers for the specified
amount of time. Use the duration parameter to specify the
time in seconds.
loadConfig
N/A
Load saved configuration and restart the system without
rebooting the servers. Use the fileName parameter to
specify the configuration to be loaded.
7–4
Admin
TABLE 7–1
System
Parameter
Field
Length
removeSavedC N/A
onfig
removeTransfe N/A
rredFile
Description
Removes the saved configuration of the system. Use the
fileName parameter to remove a certain configuration from
the system.
Removes a previously transferred file from both the
servers.
Use the localFileName parameter to specify the local file
name.
restart
N/A
revertSoftwar N/A
eUpgrade
Restart system (all the CEs).
Reverts the last live software upgrade. Use the
revertMode parameter to revert upgrade by selecting
option forced or normal.
saveConfig
N/A
Save the current configuration. Use the fileNameSuffix
parameter to save the current configuration.
softReset
N/A
Restarts the system without rebooting the server(s).
stopFileTrans N/A
fer
Stops the file transfer. Use the localFileName parameter
to specify the local file name.
switchover
N/A
Restart the system without rebooting the server(s).
transferFile
N/A
Initiates a file transfer from specified remote location.
Options are:
• from - Remote host name or IP address from where to get the
file.
• password - Password for the remote host.
• remoteFileName - Absolute path name of the file to transfer.
• userName - Login for the remote host.
7–5
System
TABLE 7–1
Parameter
Admin
Field
Length
resetOffender N/A
sList
Description
Request the detailed accounting of the individual POLICER
packet rejections and offender list. You can get offender list
for the following:
• aclOffendersList - Specifies the offenders contributing to
ACL rule packet discards.
• aggregateOffendersList - Specifies the offenders
contributing to aggregate policing discards.
• arpOffendersList - Specifies the offenders contributing to
ARP packet related discards.
• badEtherIpHdrOffendersList - Specifies the offenders
contributing to discards since their packets contained a
malformed IP header.
• discardRuleOffendersList - Specifies the offenders
contributing to default system discard rule related discards.
• ipSecDecryptOffendersList • mediaOffendersList - Specifies the offenders contributing
to media policer discards.
• rogueMediaOffendersList - Specifies the offenders
contributing to rogue media related discards.
• uFlowOffendersList - Specifies the offenders contributing
to micro-flow policer discards.
Command Example
To display system configuration information:
% show system admin
admin merc {
cliIdleTimeout
30;
managementIpVersion ipv4;
auditLogState
enabled;
}
Transferring Files to the system
You can initiate a file transfer from specified remote location to SBC 5x00 using
the following CLI commands:
% request system admin <machine_name> transferFile
from - Remote host name/IP address from where to get the
file.
password - Password for the remote host.
remoteFileName - Absolute path name of the file to transfer.
userName - Login for the remote host.
7–6
Admin
System
CLI Example:
% request system admin SBX_hornettest5 transferFile from
merc password admin remoteFileName /opt/sonus/external/
testfile1.der userName root
7–7
System
Congestion
Congestion
The congestion objects provide a facility for managing the call congestion on SBC
5x00. Following system congestion levels are defined for SBC 5x00. Each level
represents an increasing severity of congestion within the SBC 5x00:
•
•
•
•
•
•
adaptive - When activated by a congestion event, an adaptive algorithm
supplements the congestion control algorithm and iteratively adjusts the call
acceptance rate up or down to maintain a target CPU load (~95%) and
maximize call throughput throughout the overload event. The algorithm is selftuning to automatically adjust to SBC 5x00 nominal capacity (and to non-callrate related events consuming unpredictable amounts of CPU) and is
independent of call scenario mix, signaling types, and user retry behavior.
There is a single default configuration for all system configurations.
Emergency calls may optionally be given preference over non-priority calls.
levelMC1 - Limited congestion in which only a percentage (P1) of ingress
calls, but all priority calls, are processed.
levelMC2 - Increased (over level MC1) congestion in which a smaller
percentage (P2) of ingress calls, but all priority calls, are processed.
levelMC3 - High congestion in which no calls are processed, including
priority calls.
mode - Mode (static or adaptive) of the system overload control.
policer - System congestion Call Rate Policer configuration.
In levels MC1 and MC2, the SBC 5x00 software will attempt to balance traffic by
assigning H.323 and SIP calls to non-congested modules. In levels MC1, MC2,
and MC3, all INFO event log messages are suppressed.
These congestion levels only apply to the packet calls. You define the thresholds
at which these congestion levels are triggered, and the rate at which ingress call
processing is throttled by associating each level with an Overload Profile.
Independent congestion criteria thresholds and durations are specified in the
Overload Profile:
•
•
CPU utilization on server
Memory utilization on server
By configuring the Overload Profile appropriately, some of the congestion criteria
can trigger a change in the congestion level.
Congestion Policer
During sustained system, the SBC 5x00 accepts calls at a smooth rate, avoiding
behavior such as accepting all calls for a short period of time and then rejecting all
calls for the remaining sampling period. This is accomplished with system-level
policers. Unlike IP Traffic Policers--which control the allowed rate of incoming IP
packets, congestion policers control the allowed rate of incoming calls in a
system. Individually configurable bucket sizes (POLICER BUCKETSIZE) controls
the call burst handling capability. The policer fill rate controls the sustained rate
7–8
Congestion
System
(the rate at which tokens are added to the bucket). In this case, the fill rate is the
sustained call rate allowed at calls per second (CPS). Fill rates are not
configurable when using congestion policers; instead, they are dynamically
adjusted based on resource usage, to maximize those resources. For more
information on policers, buckets, fill rates and so on, refer to "IP Access Control
List" on page 3–14.
Command Syntax
% set system congestion adaptive MCLevel <MCLevel>
% set system congestion <levelMC1> mode <mode>
overloadProfileName <defaultMC1>
% set system congestion mode <mode> <levelMC>
overloadProfileName defaultMC1 mode <mode>
% set system congestion policer burstSize <burstSize>
preference <preference>
% show system congestion
adaptive <adaptive>
levelMC1 <levelMC1>
levelMC2 <levelMC2>
levelMC3 <levelMC3>
mode <mode>
policer <policer>
% show system congestion <adaptive>
MCLevel <MCLevel>
% show system congestion <levelMC>
mode <mode>
7–9
System
Congestion
% show system congestion <policer>
burstSize <burstSize>
preference <preference>
% delete system congestion <adaptive>
% delete system congestion <levelMC>
% delete system congestion <policer>
Command Parameters
TABLE 7–2
Congestion Parameters
Parameter
Field
Length
MCLevel
N/A
Description
Sets the system machine congestion level at which the
system adaptive algorithm activates:
• mc0 - set to this level during LWSU to disable the system
adaptive algorithm.
• mc1 - Adaptive congestion control is activated at system
congestion level mc1.
levelMC1
N/A
Specifies the operational state of machine congestion level
1 or MC1. The options are:
• mode - Specifies the Maintenance mode of MC1. Options are:
- inService - Specifies the most recently assigned Overload
Profile is validated and activated.
- outOfService (default) - Specifies the congestion control
processing for machine level 1 is suspended so that a new
Overload Profile can be assigned.
• overloadProfileName - Specify the Overload Profile name
of MC1. Options are:
- defaultMC1 - Specifies the name of the Overload Profile
assigned to Machine Congestion Level 1 (MC1). Select the
appropriate mode.
appropriate mode.
appropriate mode.
7–10
Congestion
TABLE 7–2
System
Congestion Parameters (Continued)
Parameter
Field
Length
levelMC2
N/A
Description
• overloadProfileName - Specifies the Overload Profile of
MC2. Options are:
appropriate mode.
appropriate mode.
appropriate mode.
levelMC3
N/A
• overloadProfileName - Specifies the Overload Profile
name for MC3. Options are:
that you are assigning to Machine Congestion Level 1 (MC1).
Select the appropriate mode.
mode
N/A
Specifies the system overload control mode. It can be:
• adaptive - Adaptive overload control mechanism is applied.
• static - Static overload control mechanism is applied.
7–11
System
TABLE 7–2
Congestion
Congestion Parameters (Continued)
Parameter
Field
Length
policer
N/A
Description
Specifies the system congestion Call Rate Policer
configuration. Specify with the following policer parameters:
• burstSize - Specifies the call bursting capability in number of
calls. For example, if set to 20 (and the fill rate is set to value
higher than 20), and no calls were received in the last one
second, the policer allows an instantaneous burst of 20 calls.
Must be 5-100; default is 50 calls for system level and 20 calls
for server level.
• preference - Specifies the three types of traffic that will be
assigned a preference. The value of the preference is between
0 to 3, where 0 is the highest and 3 is the lowest preference.
They are:
- call - Preference value that is applied during normal call
admission.
- emergencyCall - Preference value that is applied during
emergency call admission.
- initialSipRegister - Preference value that is applied
during initial SIP registration admission.
displaylevel 1-64
commands.
Command Example
To display congestion configuration information:
% show system congestion
levelMC1 {
mode
outOfService;
overloadProfileName defaultMC1;
}
levelMC2 {
mode
outOfService;
}
levelMC3 {
mode
outOfService;
}
mode adaptive;
adaptive {
7–12
Congestion
System
MCLevel mc2;
}
policer {
burstSize 50;
}
7–13
System
DSP Packet Assembler Disassembler (PAD) Resources
DSP Packet Assembler Disassembler (PAD)
Resources
This object allows you to specify the characteristics of the DSP packet assemble
and disassemble (PAD) resources in the SBC 5x00. DSP PAD is used for
transcoding between different media codecs and/or different packetization times,
detecting fax and/or modem tones, interworking DTMF transport modes, and
detecting DTMF digits.
The following audio codecs are supported in the SBC 5x00 DSP PAD:
•
•
•
•
•
•
G.711
G.729A
G.729A+B (Silence Suppression)
G.726
G.273
iLbc
A packet outage is the loss of incoming voice (RTP) packets. If the PAD on the
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 the 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 the server. The counter can be reset
using PACKET OUTAGE RESET TOTAL COUNTER.
Packet outage 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.
Media Performance Data
The SBC 5x00 monitors the packet loss and jitter exceeding the jitter buffers
capacity using the playout time series. The playout time series consists of 31
quality measurements, with each measurement representing a consecutive time
period. Taken as a whole, the measurements represent how the playout buffer
viewed the jitter and packet loss over consecutive time periods. Within each time
period the quality is classified into four possible values:
•
•
•
•
7–14
Good
Acceptable
Poor
Unacceptable
System
Anytime the playout buffer has no data to play due to packet loss or excessive
jitter, the SBC 5x00 keeps track of the missing data duration over a time period.
The total duration of the missing data over a time period is compared against
three programmable thresholds to classify the performance during the period
(THRESHOLD0, THRESHOLD1, and THRESHOLD2). The threshold comparison
is listed in the table below.
TABLE 7–3
Threshold Comparison
If the duration of the missing data is
Then the quality is considered
Less than or equal to THRESHOLD0,
Good
Greater than THRESHOLD0 and less than Acceptable
THRESHOLD1,
Greater than THRESHOLD1 and less than Poor
THRESHOLD2,
Greater than THRESHOLD2.
Unacceptable
The time series provides an approximate indication of the location where problem
arises in the packets, for exactly determining the call problems. For example, a
large single-event outage or a continuous series of packet issues distributed
throughout the call.
Since the time period is fixed, the duration of the calls affect the number of time
period intervals that are used for collecting data. By using a default time period of
20 seconds, a short call of 1-30 seconds, produces data for one or two time
periods, whereas a longer call of 10 minutes will have data for the last 30 time
periods. The calls which lasts more than 31 time periods will have data only for the
last 31 time periods of the call (old data is discarded). If you wish to obtain data at
a more granular level, you can configure the time period to be shorter, however
this precludes you from monitoring longer calls (since only the last 31 time periods
are recorded).
Configuring the Playout Time Series Period and Thresholds
To configure the playout time series parameters, you set the thresholds to detect a
certain percentage of missing data within a time period. For example, to configure
a 20-second time period where between 1 and 2 percent of missing data is
considered Poor quality, and more than 2 percent of missing data is considered
Unacceptable:
1. Calculate the duration of the percentages of the 20-second period:
1 percent of 20 seconds = 0.2 seconds (200msec)
2 percent of 20 seconds = 0.4 seconds (400msec)
2. Assign these values (in milliseconds) to playoutTimeseriesThreshold1
and playoutTimeseriesThreshold2. The
playoutTimeseriesThreshold0 is generally set to 0 (default).
The following CLI commands illustrate the example above.
% set system dspPad playoutTimeseriesPeriod 20000
% set system dspPad playoutTimeseriesThreshold1 200
% set system dspPad playoutTimeseriesThreshold12 400
7–15
System
Command Syntax
% set system dspPad
comfortEnergy <comfortEnergy>
jitterEvalPeriod <jitterEvalPeriod>
jitterMinOccThsh <jitterMinOccThsh>
playoutTimeseriesPeriod <playoutTimeseriesPeriod>
playoutTimeseriesThreshold0 <playoutTimeseriesThreshold0>
rtpDtmfRelay <rtpDtmfRelay>
sidHangoverTime <sidHangoverTime>
sidMaxNoiseFloor <sidMaxNoiseFloor>
sidMaxTime <sidMaxTime>
sidMinNoiseFloor <sidMinNoiseFloor>
sidMinTime <sidMinTime>
toneThreshold <toneThreshold>
toneThresholdState <toneThresholdState>
universalCompressionThreshold
<universalCompressionThreshold>
universalCompressionThresholdState
<universalCompressionThresholdState>
% show system dspPad
comfortEnergy <comfortEnergy>
jitterEvalPeriod <jitterEvalPeriod>
jitterMinOccThsh <jitterMinOccThsh>
playoutTimeseriesPeriod <playoutTimeseriesPeriod>
rtpDtmfRelay <rtpDtmfRelay>
sidHangoverTime <sidHangoverTime>
sidMaxNoiseFloor <sidMaxNoiseFloor>
sidMaxTime <sidMaxTime>
sidMinNoiseFloor <sidMinNoiseFloor>
7–16
System
sidMinTime <sidMinTime>
toneThreshold <toneThreshold>
toneThresholdState <toneThresholdState>
<universalCompressionThreshold>
universalCompressionThresholdState
<universalCompressionThresholdState>
% delete system dspPad
Command Parameters
TABLE 7–4
Parameter
DSP Pad Resources Parameters
Field
Length
Description
comfortEnerg N/A
y
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 fill
in the audio when packet loss occurs; it is played until the
first packet is received. Whenever there is a drop in packets
(packet loss or silence periods), the G711SS represents the
level of comfort noise, when no SID is received. Must be 90dBm0 to -35dBm0, default is 56 (or -56 dBm0).
jitterEvalPe N/A
riod
Specifies the jitter evaluation period. It is also the time period
to decide the periodical evaluation of playout occupancy in
milliseconds. This parameter determines the rate at which
the jitter buffer is adapted. This parameter can be set in the
range between 0.5 seconds to 2 seconds. If the value is too
small, then the jitter buffer algorithm may tend to discard
samples too aggressively causing small losses of audio. If
the value is too large, then the excess delay built up in the
jitter buffer will remain for a long time before it can be
removed. The default setting of 1 second is a reasonable
compromise. Must be 10-300000, default is 1000.
7–17
System
TABLE 7–4
Parameter
DSP Pad Resources Parameters (Continued)
Field
Length
Description
jitterMinOcc N/A
Thsh
Specifies the minimum jitter buffer occupancy threshold (in
milliseconds) that is, the occupancy below which the playout
time is advanced if the occupancy has existed for the
jitterEvalPeriod. This value should be 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. The value is
used to prevent excess delay from building up in the jitter
buffer. If the network jitter is small enough, then occupancy
will gradually be brought down to this level or possibly lower.
The expected jitter threshold should be set to equal or
slightly larger than the jitter to obtain minimum delay. If the
actual jitter is higher, then some samples may (infrequent)
be discarded, depending on the statistics of the signal. If the
actual jitter is somewhat smaller, then some accumulated
delay (less than or equal to this value will be formed) in the
jitter buffer. This represents the trade-off between
maintaining minimum delay and discarding samples. Must
be between 2-200 (covering a delay of 2 to 200
milliseconds), default is 20 (milliseconds). Setting this
number to 200 will disable jitter buffer adaptation.
playoutTimes N/A
eriesPeriod
Specifies the recording interval size (in milliseconds) used
by the SBC 5x00 when monitoring RTP playout buffer
quality; used only when an RTP stream is terminated. This
parameter applies only to the RTP playout buffer in the DSP
and does not apply to the RTP monitoring function in the
network processor. This value must be greater than or equal
to 10000 (10 seconds) and less than or equal to 240000
(240 seconds). The default is 20000 (20 seconds).
playoutTimes N/A
eriesThresho
ld0
Specifies the playout loss time series threshold (in
milliseconds) used by the SBC 5x00 when quantifying
packet loss as applied to the playoutTimeseriesPeriod.
Loss durations less than or equal to Threshold0 are
considered Good. Loss durations greater than Threshold0
and less than Threshold1 are considered Acceptable. The
default is 0 (0.0 seconds, or 0 percent of the
playoutTimeseriesPeriod).
This parameter is applicable for all channel instances.
7–18
TABLE 7–4
Parameter
System
Field
Length
playoutTimes N/A
eriesThresho
ld1
Description
Loss durations greater than Threshold0 and less than
Threshold1 are considered Acceptable. Loss durations
greater than Threshold1 and less than Threshold2 are
considered Poor. The default is 200 (0.2 seconds, or 1
percent of the playoutTimeseriesPeriod).
playoutTimes N/A
eriesThresho
ld2
Loss durations greater than Threshold1 and less than
Threshold2 are considered Poor. Loss durations greater
than Threshold2 are considered Unacceptable. The default
is 600 (0.6 seconds, or 3 percent of the
playoutTimeseriesPeriod).
rtpDtmfRelay N/A
This integer specifies the RTP payload type to use for DTMF
Relay during compressed calls. Must be 96-127, default is
100. When running RFC 2833 with H.323 or SIP signaling,
H.323 disallows 0-95.
sidHangoverT N/A
ime
This integer specifies the minimum time (in milliseconds),
after voice is detected inactive before sending a SID packet.
Must be 80-2560, default is 300 (milliseconds).
sidMaxNoiseF N/A
loor
This (positive) integer specifies the maximum noise level;
above this noise level is considered to be speech (in
dBm0s). Must be -62dBm0 to -24dBm0, default is 48 (or -48
dBm0).
N/A
This integer specifies the maximum time between SID
packets (in milliseconds). 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 purpose. This value must exceed the
sidMinTime (below). Must be 50-300000, default is 2000
(or 2 seconds).
sidMinNoiseF N/A
loor
This (positive) integer specifies the minimum noise level;
below this noise level is considered to be silence (in
dBm0s). Must be -62dBm0 to -24dBm0, default is 60 (or -60
dBm0).
sidMaxTime
7–19
System
TABLE 7–4
Parameter
Field
Length
Description
sidMinTime
N/A
Minimum time between silence packets.
This integer specifies the minimum time between SID
packets, in milliseconds. 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).
toneThreshol N/A
d
Specifies the percentage of threshold crossing value for tone
resources. Default value is 90.
toneThreshol N/A
dState
Specifies the state of the tone threshold event. Options are
enabled and disabled.
universalCom N/A
pressionThre
shold
This positive integer specifies the percentage of usage the
usage threshold for universal compression resources in the
node. When this usage level or threshold is reached, an
event (and possibly a trap) will be generated. Must be 1-100,
default is 90.
universalCom N/A
pressionThre
sholdState
Specifies a trap will be generated, when universal
compression resources are reduced beyond a threshold
value:
• enabled (default) - generate the trap
• disabled - do not generate the trap
displayleve
l
1-64
commands.
Command Example
To display the DSP pad resources parameters:
% show system dspPad
jitterEvalPeriod
1000;
jitterMinOccThsh
20;
rtpDtmfRelay
100;
sidMinTime
200;
sidMaxTime
2000;
sidHangoverTime
300;
sidMinNoiseFloor
60;
sidMaxNoiseFloor
48;
comfortEnergy
56;
90;
universalCompressionThresholdState enabled;
7–20
System
playoutTimeseriesPeriod
20000;
playoutTimeseriesThreshold0
0;
200;
600;
toneThreshold
90;
toneThresholdState
enabled;
[ok][2010-04-28 04:23:28]
7–21
System
Ethernet Port
Ethernet Port
This object allows you to configure the ethernet port, index, link speed and
administrative state of the port.
Command Syntax
// Manadatory parameters required to configure an Ethernet port.
% set system ethernetPort mgmtAdmin <mgmtAdmin> <mgt>
portIndex <portIndex>
% set system ethernetPort packetAdmin <pkt> portIndex
<portIndex>
// Non-manadatory parameters that can be used to configure or display Ethernet
port settings.
% show system ethernetPort
mgmtAdmin <mgmtAdmin>
packetAdmin <pkt>
% show system ethernetPort mgmtAdmin <mgmtAdmin>
portIndex <portIndex>
% show system ethernetPort packetAdmin <pkt> portIndex
<portIndex> displaylevel <displaylevel>
% delete system ethernetPort
Command Parameters
TABLE 7–5
Ethernet Port Parameters
Parameter
Field
Length
Description
mgmtAdmin
N/A
Specifies the host name of the server.
mgt
N/A
Specifies management port.
• mgt0
• mgt1
portIndex
7–22
N/A
Specifies the internal port index.
Ethernet Port
TABLE 7–5
System
Ethernet Port Parameters (Continued)
Parameter
Field
Length
Description
pkt
N/A
Specifies the packet. Options are:
•
•
•
•
displaylevel 1-64
pkt0
pkt1
pkt2
pkt3
commands.
Command Example
To display ethernet port configuration:
% show system ethernetPort
packetAdmin merc pkt0 {
portIndex 2;
}
portIndex 3;
}
portIndex 4;
}
portIndex 5;
}
mgmtAdmin merc mgt0 {
portIndex
0;
}
mgmtAdmin merc mgt1 {
portIndex
1;
}
7–23
System
Interval Statistics
Interval Statistics
The performance statistics allows you to examine various usage statistics within a
time interval. These statistics are available on a real time (CURRENT) or on a
historical (INTERVAL) basis. By default, the SBC 5x00 maintains four 15-minute
intervals of data, so that at any time the previous hour data is available. The
number of intervals and the size of the interval are configurable.
Command Syntax
% set system intervalStatistics
numOfPastIntervals <numOfPastIntervals>
timeInterval <timeInterval>
% show system intervalStatistics
numOfPastIntervals <numOfPastIntervals>
timeInterval <timeInterval>
% delete system intervalStatistics
Command Parameters
TABLE 7–6
Parameter
Interval Statistics Parameters
Field
Length
Description
numOfPastInt N/A
ervals
Specifies the number range of past interval that can be
configured for retrieving the statistics data. Must be 1-12
(intervals), default is 4.
timeInterval N/A
Specifies the range of the timer interval (in minutes) that
can be used by the configuration management for activities
such as to measure the statistics of certain resources.
Must be 5-60 (minutes), default is 15.
displaylevel 1-64
7–24
commands.
Interval Statistics
System
Command Example
To display interval statistics configuration:
% show system intervalStatistics
timeInterval
15;
numOfPastIntervals 4;
7–25
System
Logical Management IP Interface
Logical Management IP Interface is a virtual management IP interface. This
interface is designed to represent the MNS group by a single IP interface.
Command Syntax
set system logicalMgmtIpInterface <logicalMgmtIpInterface>
mgmtIpInterfaceGroupName <mgmtIpInterfaceGroupName>
state <state>
% show system logicalMgmtIpInterface
<logicalMgmtIpInterface>
mgmtIpInterfaceGroupName <mgmtIpInterfaceGroupName>
state <state>
% delete system logicalMgmtIpInterface
<logicalMgmtIpInterface>
Command Parameters
TABLE 7–7
Parameter
Interval Statistics Parameters
Field
Length
Description
logicalMgmtI N/A
pInterface
Specifies the logical management IP interface name.
N/A
Specifies the logical IP address of the interface. The
ipAddress
example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
mgmtIpInterf N/A
aceGroupName
7–26
Specifies the management IP interface group used by this
logical IP interface.
TABLE 7–7
System
Interval Statistics Parameters (Continued)
Parameter
Field
Length
state
N/A
Description
Specifies the administrative state of the logical
management IP interface. Options are:
• disabled - The logical management IP address is not being
used for chassis management.
• enabled - The logical management IP address is being used
for chassis management.
displaylevel 1-64
commands.
Command Example
To display the logical management IP interface configuration:
% show system logicalMgmtIpInterface LogMgmt
mgmtIpInterfaceGroupName mgmtGroup;
ipAddress
state
3FFE:1900:4545:3:200:F8FF:FE21:67CF;
disabled;
To display the logical management IP interface configuration for two subnet:
% show system logicalMgmtIpInterface
logicalMgmtIpInterface AGMGM {
mgmtIpInterfaceGroupName mgmtGroup1;
ipAddress
10.54.67.50;
state
enabled;
}
logicalMgmtIpInterface HAMGM {
ipAddress
10.54.66.65;
state
enabled;
}
NOTE
While configuring the management interfaces on two subnet, two
logical management IP interfaces are needed, one for each subnet .
7–27
System
Media
Media
SBC 5x00 supports the following Real Time Control Protocol (RTCP) modes for
media:
•
•
RTCP Relay for pass-thru calls - RTCP is relayed between the two endusers. The SBC 5x00 will not terminate the RTCP sessions, it will however
instruct the network processor (NP) to setup the media-path to forward RTCP
packets from one party to the other.
RTCP termination by the NP - The NP will terminate the RTCP sessions and
is responsible for running the RTCP protocol/packet engine.
In both modes, the NP collects packet RTCP and reports them for output to CDRs.
SBC 5x00 also supports RTP/RTCP inactivity detection. The media object allows
you to configure the following:
•
•
•
Media peer inactivity - Used to configure media peer inactivity time out value.
Media port range - Used to configure base UDP port and maximum UDP port.
Media RTCP control - Used to configure sender report interval.
Command Syntax
%
set system media mediaPeerInactivity
inactivityTimeout <inactivityTimeout>
%
set system media mediaPortRange
baseUdpPort <baseUdpPort>
maxUdpPort <maxUdpPort>
%
set system media mediaRtcpControl
senderReportInterval <senderReportInterval>
% show system media
mediaPeerInactivity
mediaPortRange
mediaRtcpControl
%
set system media mediaPeerInactivity
7–28
Media
System
%
show system media mediaPortRange
%
set system media mediaRtcpControl
% delete system media mediaPeerInactivity
%
delete system media mediaPortRange
%
delete system media mediaRtcpControl
Command Parameters
TABLE 7–8
Media Parameters
Parameter
Field
Length
inactivityTi N/A
meout
Description
Specifies the RTP/RTCP inactivity timeout value. The
default value is 60 seconds. The valid range is between 20
to 1260 seconds. The timeout value must be a multiple of
10 seconds.
baseUdpPort
N/A
Specifies the base UDP port number for RTP media
(inclusive). Default port number is 1024.
maxUdpPort
N/A
Specifies the maximum UDP port number for RTP media
(exclusive). Default port number is 65148.
senderReport N/A
Interval
Specifies the RTCP SR (sender report) interval when RTCP
is terminated by NP. Default value is 5 seconds.
displaylevel 1-64
commands.
7–29
System
Media
Command Example
To display media configuration:
% show system media
mediaPeerInactivity {
inactivityTimeout 20;
}
mediaRtcpControl {
senderReportInterval 8;
}
7–30
Media Profile
System
Media Profile
The media profile object creates a template for the audio compression capabilities
to be utilized on server modules of SBC 5x00. The following compression types
may be specified in a media profile object:
•
•
•
•
amrNb - AMR Narrow Band codec
•
g7xx - G.726/729/723 codecs
•
g722 - G.722 codec
•
tone - Tones and Announcements
•
iLbc - Internet Low Bit-Rate Codec and iLbcSS (Silence Suppression)
amrWb - AMR Wide Band codec
evrc0 - Enhanced Variable Rate codec
evrcb - Enhanced Variable Rate Codec-B
NOTE
Codecs amrWb, amrNb, evrcb, evrc0 and g722 require user licenses
while the g7xx, iLbc, and tone do not require user licenses.
NOTE
After you change the media profile, you need to restart the SBC 5x00
application for the DSPs to reload.
Command Syntax
% set system mediaProfile
amrNb <amrNb>
amrWb <amrWb>
evrc0 <evrc0>
evrcb <evrcb>
g7xx <g7xx>
g722 <g722>
iLbc <ilbc>
tone <tone>
% show system mediaProfile
amrNb <amrNb>
7–31
System
Media Profile
amrWb <amrWb>
evrc0 <evrc0>
evrcb <evrcb>
g7xx <g7xx>
g722 <g722>
iLbc <ilbc>
tone <tone>
Command Parameters
TABLE 7–9
Media Profile Parameters
Parameter
Field
Length
amrNb
N/A
Specifies the percentage allocation of DSP cores for amrNb
codec type. Must be 0 - 100, default value is 0.
amrWb
N/A
Specifies the percentage allocation of DSP cores for amrWb
evrc0
N/A
Specifies the percentage allocation of DSP cores for evrc0
evrcb
N/A
Specifies the percentage allocation of DSP cores for evrcb
g7xx
N/A
Specifies the percentage allocation of DSP cores for g7xx
g722
N/A
Specifies the percentage allocation of DSP cores for g722
ilbc
N/A
Specifies the percentage allocation of DSP cores for iLbc
tone
N/A
Specifies the percentage allocation of DSP cores for tone
displaylevel 1-64
7–32
Description
commands.
Media Profile
System
Command Example
NOTE
The total percentage of all the DSP cores must always be equal to 100.
To display media profile parameters:
% show system mediaProfile
g7xx
10;
iLbc
10;
amrWb 10;
g722
10;
amrNb 10;
evrcb
tone
10;
40;
evrc0 0;
7–33
System
Management IP Interface Group
This object allows you to configure a group of management IP interfaces for the
default address context.
NOTE
When a user creates a new management group the user must add user
defined ACL rules to get the equivalent rules that are set up for the
default management group.
Command Syntax
% set system mgmtIpInterfaceGroup <mgmtIpInterfacegroup>
ceName <ceName>
ipAddressV4 <ipAddressV4>
portName <portName>
prefixV4 <prefixV4>
prefixV6 <prefixV6>
state <state>
NOTE
For management interface groups (and interfaces), the default address
context is implied and therefore the address context is not specified.
% show system mgmtIpInterfaceGroup <mgmtIpInterfaceGroup>
% show system mgmtIpInterfaceGroup <mgmtIpInterfaceGroup>
ceName <ceName>
portName <portName>
prefixV4 <prefixV4>
7–34
System
prefixV6 <prefixV6>
state <state>
% delete system mgmtIpInterfaceGroup
Command Parameters
TABLE 7–10 Management IP Interface Group Parameters
Parameter
Field
Length
Description
mgmtIpInterfa 1-23
ceGroup
Specifies a group of management IP interfaces for the
default address context. Must be 1-23 characters.
mgmtIpInterfa 1-23
ce
Specifies the management IP interface name. Must be 1-23
characters.
ceName
1-255
Specifies the name of the compute element that hosts the
port used by management IP interface. Must be 1-255
characters.
NOTE
ceName identifies each node
(active or standby). System name
identifies the HA pair. SBC 5x00
is deployed in 1:1 redundancy
(active or standby).
dryupTimeout
N/A
Specifies the dryup timeout in minutes. The number of
minutes to wait for the active calls to complete before
dropping the call. Must be 1-1440, default is 60.
ipAddressV4
N/A
Specifies the IP address of the interface.
For IPv4, the length should be in the range of 0 to 32. The
32-bit IP address in dotted decimal form (for example
128.127.50.224).
ipAddressV6
N/A
Specifies the IP address of the interface.
For IPv6, the length should be in the range of 0 to 128. The
eight 16-bit IP address in hexadecimal values separated by
colons (for example
1280:1276:3350:2224:2222:3333:8888:1245).
portName
N/A
Specifies the port used by management IP interface.
Options are:
• mgt0
• mgt1
7–35
System
TABLE 7–10 Management IP Interface Group Parameters (Continued)
Parameter
Field
Length
prefixV4
0-32
Specifies the IPv4 subnet prefix of management interface.
prefixV6
0-32
Specifies the IPv6 subnet prefix of management interface.
state
N/A
Specifies the administrative state of the management
network interface.
Description
• disabled (default) - in this state the management IP interface
is inactive and it does not respond to a ping.
• enabled - in this state the management IP interface is active
and it responds to a ping, if the Ethernet cable is plugged in.
displaylevel 1-64
7–36
command.
System
Command Example
To display management IP interfaces:
% show system mgmtIpInterfaceGroup
mgmtIpInterfaceGroup mgmtGroup {
mgmtIpInterface mgmtIntf1 {
ceName
merc;
portName
mgt0;
ipAddressV4 10.34.26.151;
prefixV4
3;
ipAddressV6 ::FFFF:10.34.26.151;
prefixV6
64;
state
enabled;
}
ceName
merc;
portName
mgt1;
prefixV4
24;
prefixV6
64;
state
enabled;
}
}
To create management interfaces on two subnets in SBC 5x00 HA setup:
Step 1: Add mgmtIntf2 and mgmtIntf4 to newly created mgmtGroup1
set system mgmtIpInterfaceGroup mgmtGroup mgmtIpInterface
mgmtIntf2 state disabled
commit
delete system mgmtIpInterfaceGroup mgmtGroup mgmtIpInterface
mgmtIntf2
commit
set system mgmtIpInterfaceGroup mgmtGroup1
commit
set system mgmtIpInterfaceGroup mgmtGroup1 mgmtIpInterface
mgmtIntf2 ceName hayabusa portName mgt1 ipAddressV4
10.54.67.47 prefixV4 24 ipAddressV6 ::FFFF:10.54.67.47
prefixV6 64
commit
7–37
System
mgmtIntf2 state enabled
commit
set system mgmtIpInterfaceGroup mgmtGroup mgmtIpInterface
mgmtIntf4 state disabled
commit
delete system mgmtIpInterfaceGroup mgmtGroup mgmtIpInterface
mgmtIntf4
commit
mgmtIntf4 ceName augusta portName mgt1 ipAddressV4
10.54.67.48 prefixV4 24 ipAddressV6 ::FFFF:10.54.67.48
prefixV6 64
commit
mgmtIntf4 state enabled
commit
show system mgmtIpInterfaceGroup mgmtIpInterfaceGroup
mgmtGroup
{
ceName
hayabusa;
portName
mgt0;
prefixV4
24;
prefixV6
64;
state
enabled;
}
ceName
augusta;
portName
mgt0;
prefixV4
24;
prefixV6
64;
state
enabled;
}
}
7–38
System
mgmtIpInterfaceGroup mgmtGroup1 {
ceName
hayabusa;
portName
mgt1;
prefixV4
24;
prefixV6
64;
state
enabled;
}
ceName
augusta;
portName
mgt1;
prefixV4
24;
prefixV6
64;
state
enabled;
}
}
Step 2: Add static routes referencing the management interface:
set system mgmtStaticRoute 0.0.0.0 0 10.54.66.1 mgmtGroup
mgmtIntf1 preference 10
set system mgmtStaticRoute 0.0.0.0 0 10.54.66.1 mgmtGroup
set system mgmtStaticRoute 0.0.0.0 0 10.54.67.1 mgmtGroup1
set system mgmtStaticRoute 0.0.0.0 0 10.54.67.1 mgmtGroup1
show table system mgmtStaticRoute
DESTINATION
IP ADDRESS
PREFIX
PREFERENCE
NEXT HOP
IP
IP
INTERFACE
INTERFACE
GROUP NAME
NAME
------------------------------------------------------------------0.0.0.0
0
10.54.66.1
mgmtGroup
mgmtIntf1
10
0.0.0.0
0
10.54.66.1
mgmtGroup
mgmtIntf3
10
0.0.0.0
0
10.54.67.1
mgmtGroup1
mgmtIntf2
10
7–39
System
0.0.0.0
0
10.54.67.1
mgmtGroup1
mgmtIntf4
10
Step 3: Add ACL rules on mgmtGroup1:
show table addressContext default ipAccessControlList rule
SOURCE
DESTINATION
ADDRESS
ADDRESS
IP
MGMT IP
INTERFACE IP
INTERFACE
MGMT IP
SOURCE
IP
PREFIX
DESTINATION PREFIX
SOURCE DESTINATION
BUCKE
NAME
PRECEDENCE PROTOCOL GROUP
INTERFACE GROUP
INTERFACE
ADDRESS
LENGTH
IP ADDRESS
LENGTH
PORT
PORT
ACTION FILL RATE
SIZE
mgmt2_22
200
tcp
mgmtGroup1 mgmtIntf2
0.0.0.0
0
0.0.0.0
0
any
22
accept 100
10
mgmt2_80
201
tcp
0.0.0.0
0
0.0.0.0
0
any
80
accept 100
10
mgmt4_22
300
tcp
0.0.0.0
0
0.0.0.0
0
any
22
accept 100
10
mgmt4_80
301
tcp
0.0.0.0
0
0.0.0.0
0
any
80
accept 100
10
mgmt2_123
103
udp
0.0.0.0
0
0.0.0.0
0
123
any
accept 4
4
mgmt2_161
202
udp
0.0.0.0
0
0.0.0.0
0
any
161
accept 50
10
mgmt2_162
104
udp
0.0.0.0
0
0.0.0.0
0
162
any
accept 10
10
mgmt2_443
208
tcp
0.0.0.0
0
0.0.0.0
0
any
443
accept 100
10
mgmt4_123
303
udp
0.0.0.0
0
0.0.0.0
0
123
any
accept 4
4
mgmt4_161
302
udp
0.0.0.0
0
0.0.0.0
0
any
161
accept 50
10
mgmt4_162
304
udp
0.0.0.0
0
0.0.0.0
0
162
any
accept 10
10
mgmt4_443
308
tcp
0.0.0.0
0
0.0.0.0
0
any
443
accept 100
10
mgmt2_1812
105
udp
0.0.0.0
0
0.0.0.0
0
1812
any
accept 4
4
mgmt2_1813
110
udp
0.0.0.0
0
0.0.0.0
0
1813
any
accept 1200
250
mgmt2_2022
206
tcp
0.0.0.0
0
0.0.0.0
0
any
2022
accept 10
10
mgmt2_2024
209
tcp
0.0.0.0
0
0.0.0.0
0
any
2024
accept 2500
250
mgmt4_1812
305
udp
0.0.0.0
0
0.0.0.0
0
1812
any
accept 4
4
mgmt4_1813
310
udp
0.0.0.0
0
0.0.0.0
0
1813
any
accept 1200
250
mgmt4_2022
306
tcp
0.0.0.0
0
0.0.0.0
0
any
2022
accept 10
10
mgmt4_2024
309
tcp
0.0.0.0
0
0.0.0.0
0
any
2024
accept 2500
250
Step 4: Create two logical management IP interfaces one for each subnet:
set system logicalMgmtIpInterface mgmtGroup1 ipAddress
10.54.67.50
commit
set system logicalMgmtIpInterface AGMGM
mgmtIpInterfaceGroupName mgmtGroup1 state enabled
commit
set system logicalMgmtIpInterface mgmtGroup ipAddress
10.54.66.65
commit
7–40
System
set system logicalMgmtIpInterface HAMGM
mgmtIpInterfaceGroupName mgmtGroup state enabled
commit
show system logicalMgmtIpInterface logicalMgmtIpInterface
AGMGM {
mgmtIpInterfaceGroupName mgmtGroup1;
ipAddress
10.54.67.50;
state
enabled;
}
logicalMgmtIpInterface HAMGM {
ipAddress
10.54.66.65;
state
enabled;
}
NOTE
If one management port goes down the other logical management IP
interface on the other subnet must be used. Two subnets is a more
robust network design.
7–41
System
Management Static Route
The mgmtStaticRoute object is used to configure static IP routes for the
management interfaces. A static route indicates the nextHop gateway and
management interface that is used for a particular peer network IP prefix.
A route preference may be configured for static routes as shown in the
command syntax. The lower the preference value, the more likely the route is
to be used.
Command Syntax
% set system mgmtStaticRoute <destinationIpAddress> <prefix>
<nextHopIPaddress> <MgmtInterfaceGroupName>
<IpInterfaceName> preference <preference>
% show system mgmtStaticRoute <IpInterfaceName> preference
<preference> displaylevel <displaylevel>
% delete system mgmtStaticRoute
Command Parameters
TABLE 7–11 Management Static Route Parameters
Parameter
Field
Length
destinationIp N/A
Address
prefix
N/A
Description
The 32-bit destination IPv4 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 IP prefix of this static route entry.
nextHopIPaddr N/A
ess
The IP address of the next system enroute to the
destination. 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.
MgmtInterface N/A
GroupName
Specifies the name of the management IP interface group.
IpInterfaceNa N/A
me
Specifies the IP interface name.
7–42
System
TABLE 7–11 Management Static Route Parameters (Continued)
Parameter
Field
Length
preference
N/A
Description
Specifies the route preference. Route preferences are used
by the lookup engine to decide the route entry to use if
multiple equivalent routes exist to the same destination. By
default, route preferences on active NIFs take the values:
• 1 - local route
• 5 - direct route
• 10 - static route
displaylevel 1-64
commands.
Command Example
To display management static route configuration:
% show system mgmtStaticRoute
mgmtStaticRoute 0.0.0.0 0 0.0.0.0 mgmtGroup mgmtIntf2 {
preference 10;
}
mgmtStaticRoute 0.0.0.0 0 10.34.26.1 mgmtGroup mgmtIntf1 {
preference 10;
}
mgmtStaticRoute 10.34.26.151 2 10.34.26.153 mgmtGroup
mgmtIntf1 {
preference 20;
}
NOTE
In a two subnet management SBC 5x00 HA setup, when user creates a
new management group it is mandatory to add static routes referencing
the management interfaces.
7–43
System
NTP Services Management
This object specifies a Network Time Protocol (NTP) server that will supply local
time to the SBC 5x00. The reference time delivered by NTP are the source of all
time stamps placed into the accounting records.
NOTE
The SBC 5x00 should get an initial time synchronization from an NTP
server before it starts accepting calls.
Command Syntax
% set system ntp peerAdmin <hostName>
maxPoll <maxPoll>
minPoll <minPoll>
state <state>
version <version>
% set system ntp timeZone <hostName> zone <zone>
NOTE
Changing the timeZone will restart the SBC 5x00 application and
impacts the service. Make sure that you change the time zone only
during the SBC 5x00 system maintenance.
% show system ntp
peerAdmin <hostName>
timeZone <hostName>
% show system ntp peerAdmin <hostName>
maxPoll <maxPoll>
minPoll <minPoll>
state <state>
7–44
System
version <version>
% show system ntp timeZone <hostName> zone <zone> displaylevel
<displaylevel>
% delete system ntp
Command Parameters
TABLE 7–12 NTP Services Management Parameters
Parameter
Field
Length
Description
hostName
N/A
Specifies the host name of the server.
ipAddress
N/A
Specifies the 32-bit IPv4 address of the server specified in
dotted decimal form (for example 10.34.26.151).
maxPoll
N/A
Specifies the maximum number of times the client polls the
server. Default value is 10.
minPoll
N/A
Specifies the minimum number of times the client polls the
server. Default value is 4.
state
N/A
Specifies the NTP server state. Options are
• disabled - The state of the NTP server is disabled.
• enabled - The state of the NTP server is enabled.
version
N/A
Specifies the NTP server version. Options are:
• version3
• version4
7–45
System
TABLE 7–12 NTP Services Management Parameters (Continued)
Parameter
Field
Length
Description
zone
N/A
Specifies the time zone. Select any one of the time zone:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
displaylevel 1-64
7–46
gmt
gmtMinus01-Azores
gmtMinus02-MidAtlantic
gmtMinus03-BuenosAires
gmtMinus04-Atlantic-Canada
gmtMinus0430-Caracas
gmtMinus05-Bogota
gmtMinus05-Eastern-US
gmtMinus05-Indiana
gmtMinus06-Central-US
gmtMinus06-Mexico
gmtMinus06-Saskatchewan
gmtMinus07-Arizona
gmtMinus07-Mountain
gmtMinus08-Pacific-US
gmtMinus09-Alaska
gmtMinus10-Hawaii
gmtMinus11-MidwayIsland
gmtPlus01-Berlin
gmtPlus02-Athens
gmtPlus03-Moscow
gmtPlus0330-Tehran
gmtPlus04-AbuDhabi
gmtPlus0430-Kabul
gmtPlus05-Islamabad
gmtPlus0530-Calcutta
gmtPlus06-Dhaka
gmtPlus07-Bangkok
gmtPlus08-HongKong
gmtPlus09-Tokyo
gmtPlus0930-Adelaide
gmtPlus10-Guam
gmtPlus11-Magadan
gmtPlus12-Fiji
gmtPlus12-Kwajalein
command.
System
Command Example
To display NTP Services Management configuration:
% show system ntp
timeZone merc {
zone gmtMinus05-Eastern-US;
}
peerAdmin merc 10.128.254.67 {
version version4;
minPoll 4;
maxPoll 10;
state
enabled;
}
7–47
System
Policy Server
Policy Server
This object allows you to configure 10 policy servers (one local server and 9
external policy servers).
SBC 5x00 acts as a centralized PSX to evenly distribute its traffic to more than
one active PSX server that is configured with the SBC 5x00. When an active
server becomes congested, the SBC 5x00 will first distribute the overflowed traffic
to one of the active severs that has the capacity, or to one of the standby servers
that is not currently congested.
A SBC 5x00 can get PSX services from one or more active servers in the loadsharing (or round-robin) mode, and one or more active servers can be configured
in the standby mode.
Following are different types of policy server configuration:
•
•
•
Global Configuration - Applicable to all policy servers.
Local Policy Server Configuration - Applicable to local (embedded) policy
server.
Remote Policy Server Configuration - Applicable to remote policy servers.
Each configuration is explained in the following sub-sections.
Global Configuration
The global configuration is applicable to all policy servers including local server
and external policy servers.
The SBC 5x00 administrator enables or disables the PSX server. When PSX is
enabled, it receives database queries from the SBC 5x00. You can enable or
disable the PSX server only in the out-of-service mode.
Command Syntax
% set system policyServer globalConfig
congestionControl <congestionControl>
mgmtInterfaceGroup <mgmtInterfaceGroup>
reconnectTimeout <reconnectTimeout>
switchOverMode <switchOverMode>
% show system policyServer globalConfig
congestionControl <congestionControl>
mgmtInterfaceGroup <mgmtInterfaceGroup>
7–48
Policy Server
System
reconnectTimeout <reconnectTimeout>
switchOverMode <switchOverMode>
% delete system policyServer globalConfig
Command Parameters
TABLE 7–13 Policy Server Global Configuration Parameters
Parameter
Field
Length Description
congestionContr N/A
ol
When this parameter is enabled, the SBC 5x00 throttles
the sending or policy requests to either active or standby
PSX. Options are:
• enabled
• disabled
mgmtInterfaceGr N/A
oup
Specifies the Management Interface Group to be used
for communication with the PSX.
reconnectTimeou N/A
t
Specifies the timeout period in seconds for re-attempting
the connection to a policy server that is in the enabled
state. Default is 10 seconds.
switchOverMode
N/A
Specifies the mode to switch over the policy server to
active state. Mode can be:
• automatic (default) - in this state the policy server
automatically retries to the previously ACTIVE Policy
Server after a switch over.
• manual - in this state you have to manually set the policy
server to ACTIVE state after a switch over.
displaylevel
1-64
Displays the different levels of output information in
show commands.
Command Example
To set the policy server global configuration:
% set system policyServer globalConfig congestionControl
enabled reconnectTimeout 5 switchOverMode automatic
To view the policy server global configuration settings:
% show system policyServer globalConfig
reconnectTimeout
5;
switchOverMode
automatic;
7–49
System
Policy Server
congestionControl enabled;
mgmtInterfaceGroup mgmtGroup;
To view the status of policy servers:
% show table system policyServer globalConfig
Local Policy Server Configuration
You can configure the local policy server that is embedded within SBC 5x00 using
the following commands.
Command Syntax
% set system policyServer localServer <localServer>
action <action>
keepAliveTimer <keepAliveTimer>
mode <mode>
retries <retries>
retryTimer <retryTimer>
state <state>
transactionTimer <transactionTimer>
% show system policyServer localServer
action <action>
dryUp
force
mode <mode>
active
alternate
outOfService
standby
retries <retries>
7–50
Policy Server
System
state <state>
% delete system policyServer localServer <localServer>
Command Parameters
TABLE 7–14 Local Policy Server Configuration Parameters
Parameter
Field
Length Description
localServer
N/A
Specifies the name of the local policy server.
action
N/A
Specifies the method on which queued transactions are
processed, when operational state is either standby or
out-of-service:
• dryup (default)— all queue entries are processed to
completion unless retries expires.
• force — all queue transactions are dropped
immediately.
keepAliveTimer
1-60
Specifies the time interval (in seconds) to wait before
issuing a “keepalive” poll to the Policy Server. This poll is
issued only if there is no other policy server activity
during this interval. The receipt of any message from the
Policy Server resets the elapsed time to 0.
7–51
System
Policy Server
TABLE 7–14 Local Policy Server Configuration Parameters (Continued)
Parameter
Field
Length Description
mode
N/A
Specifies the operational state of the local policy server:
• outofservice - The local policy server is out-of-service
and will not provide any services.
• active - The local policy server provides normal query
services.
• standby - The local policy server serves as a backup
when another server in the active mode becomes
unavailable.
• alternate - The local policy server is not expected to
receive any query messages, but can send messages to
SBC 5x00.
NOTE
If two external active PSXs are
failed and the local policy
server is in standby mode,
then the standby local policy
server is used as active server
till the external PSX becomes
active. Once an external PSX
comes back to active state, the
SBC 5x00 stops using the local
standby policy server and
uses the external PSX.
retries
0-32
Specifies the number of retries for any policy server
transaction. Must be 0-32, default is 1.
retryTimer
N/A
Specifies the time (in milliseconds) for SBC 5x00 to wait
for the response from the local Policy Server. The default
value is 2500 milliseconds.
state
N/A
NOTE
If you are changing the state,
make sure that the mode is set
to outofservice.
Specifies the administrative state of the local policy
server. Options are:
• disabled - The local policy server is not used for call
routing decisions.
• enabled - The local policy server is used for call routing
decisions.
7–52
Policy Server
System
TABLE 7–14 Local Policy Server Configuration Parameters (Continued)
Parameter
Field
Length Description
transactionTime 50r
60000
displaylevel
1-64
Specifies 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.
show commands.
Command Example
To set the local policy server configuration:
% set system policyServer localServer PSX_LOCAL_SERVER
action dryUp keepAliveTimer 3 mode standby retries 1
retryTimer 2500 state enabled transactionTimer 2500
To view the local policy server configuration settings:
% show system policyServer localServer
localServer PSX_LOCAL_SERVER {
state
enabled;
mode
standby;
action
dryUp;
transactionTimer 2500;
keepAliveTimer
3;
retryTimer
2500;
retries
1;
}
To view the status of local policy servers:
% show table system policyServer localServer
KEEP
NAME
STATE
MODE
ACTION
TRANSACTION
ALIVE
RETRY
TIMER
TIMER
TIMER
RETRIES
------------------------------------------------------------------------------PSX_LOCAL_SERVER
enabled
active
dryUp
2500
5
2500
1
Remote Policy Server Configuration
You can configure the remote policy server using the following commands:
7–53
System
Policy Server
Command Syntax
% set system policyServer remoteServer <remoteServer>
action <action>
mode <mode>
retries <retries>
state <state>
subPortNumber <subPortNumber>
% show system policyServer remoteServer <remoteServer>
action <action>
dryUp
force
mode <mode>
active
alternate
outOfService
standby
retries <retries>
state <state>
subPortNumber <subPortNumber>
% delete system policyServer remoteServer <remoteServer>
7–54
Policy Server
System
% request system policyServer remoteServer <remoteServer>
switchBack
Command Parameters
TABLE 7–15 Remote Policy Server Configuration Parameters
Parameter
Field
Length Description
remoteServer
N/A
Specifies the name of the remote policy server.
action
N/A
Specifies the method on which queued transactions are
processed, when operational state is either standby or
out-of-service:
• dryup (default)— all queue entries are processed to
completion unless retries expires.
• force — all queue transactions are dropped
immediately.
ipAddress
N/A
Specifies the IPv4 or IPv6 address of the remote policy
server. The following IP address types are supported:
example 128.127.50.224).
IPv6 - This is V6 IP address in hexadecimal/colon form
(for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
keepAliveTimer
1-60
Specifies the time interval (in seconds) to wait before
issuing a “keepalive” poll to the Policy Server. This poll is
issued only if there is no other policy server activity
during this interval. The receipt of any message from the
Policy Server resets the elapsed time to 0.
mode
N/A
Specifies the operational state of the remote policy
server:
• outofservice - The remote policy server is out-of-service
and will not provide any services to SBC 5x00.
• active - The remote policy server provides normal query
services.
• standby - The remote policy server serves as a backup
when another server in the active mode becomes
unavailable.
• alternate - The remote policy server is not expected to
receive any query messages from the SBC 5x00, but can
send messages to SBC 5x00.
7–55
System
Policy Server
TABLE 7–15 Remote Policy Server Configuration Parameters (Continued)
Parameter
Field
Length Description
portNumber
N/A
Specifies the logical port number used for IP
communication with the remote policy server. Must be 165535. Default is 3055.
retries
0-32
Specifies the number of times to retry any remote policy
server transaction. Must be 0-32, default is 1.
retryTimer
N/A
Specifies the time (in milliseconds) for SBC 5x00 to wait
for the response from the remote Policy Server. The
default value is 2500 milliseconds.
state
N/A
NOTE
If you are changing the state,
make sure that the mode is set
to outofservice.
Specifies the administrative state of the remote policy
server. Options are:
• disabled - The remote policy server is not used for call
routing decisions.
• enabled - The remote policy server is used for call routing
decisions.
subPortNumber
N/A
transactionTime N/A
r
Specifies the port number assigned for IP address of
remote policy server to communicate with subscriber
data. Must be 1-65535. Default is 3053.
Specifies 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.
displaylevel
1-64
show commands.
switchBack
N/A
Specifies the switch back to the server, when manually
configured.
The switchback is an automatic procedures where the
server in the active mode will be replaced by the one in
the standby mode, when the active server becomes
unavailable.
Command Example
To set the remote policy server configuration:
7–56
Policy Server
System
% set system policyServer remoteServer RS action dryUp
ipAddress 10.34.26.151 keepAliveTimer 4 mode standby
portNumber 3055 retries 1 retryTimer 224 state disabled
subPortNumber 3053 transactionTimer 2500
To view the remote policy server configuration settings:
% show system policyServer remoteServer
remoteServer RS {
ipAddress
10.34.26.151;
portNumber
3055;
state
disabled;
mode
standby;
action
dryUp;
transactionTimer 2500;
keepAliveTimer
4;
retryTimer
224;
retries
1;
subPortNumber
3053;
}
To view the status of remote policy servers:
% show table system policyServer remoteServer
KEEP
NAME
IP
PORT
PORT
ADDRESS
NUMBER
NUMBER
TRANSACTION
STATE
MODE
ACTION
TIMER
SUB
ALIVE
RETRY
TIMER
TIMER
RETRIES
-------------------------------------------------------------------------------------------------RS
1.2.3.4
3053
3055
disabled
outOfService
dryUp
2500
5
2500
1
7–57
System
Security Management
Security Management
This object allows you to configure MIB modules like IPsec and PKI for security
management.
IPsec
The Sonus IP security package (IPsec) provides cryptographic protection for
non-media IP traffic.
PKI
The Public Key Infrastructure (PKI) provides a common set of infrastructure
features supporting public key and certificate-based authentication based on the
RSA public/private key pairs and X.509 digital certificates.
Local Certificates
Local certificates are credentials belonging to the local system itself, which
presents to peers in order to prove its identity. You have to download local
certificate files to the system before installing the certificates.
Remote Certificates
Remote certificates are credentials belonging to Certificate Authorities (CA). The
copies of these certificates are installed in the SBC 5x00 because they are part of
a chain of certificates the local system will present to peers, or because the
corresponding CAs are trust anchors for the local system. Certificates belonging
to non-CA remote systems should also be installed as trust anchors in this
manner.
The Certificate Authority (CA) certificates and trusted remote certificates contain
public key certificates; they do not contain the private keys. The CA certificates
and remote certificates are Distinguished Encoding Rules (DER) format files; a
method for encoding a data object (such as an X.509 certificate) which uses a
digital signature to bind together a public key with an identity.
The SBC 5x00 imports these certificates from Distinguished Encoding Rules
(DER) formatted files.
To transfer files from remote server to SBC 5x00, refer to section "Transferring
Files to the system" on page 7–6.
7–58
Security Management
System
Command Syntax
% set system security ipsec
ikeDpdInterval <ikeDpdInterval>
ikeRetrasmitCount <ikeRetrasmitCount>
// Manadatory parameters required to configure a PKI certificate.
% set system security pki certificate <certificate>
fileName <fileName>
state <state>
type <type>
// Non-manadatory parameters that can be used to configure a PKI certificate.
% set system security pki certificate <certificate>
passPhrase <passPhrase>
% show system security
ipsec
ikeDpdInterval <ikeDpdInterval>
ikeRetrasmitCount <ikeRetrasmitCount>
pki
certificate <certificate>
pki certificate <certificate>
fileName <fileName>
passPhrase <passPhrase>
state <state>
type <type>
% delete system security
ipsec
% delete system security
pki
7–59
System
Security Management
Command Parameters
TABLE 7–16 Security Management Parameters
Parameter
Field
Length
Description
ikeDpdInterv N/A
al
Specifies the Dead Peer Detection interval. Default value is
3600 seconds.
ikeRetransmi N/A
tInterval
Specifies the IKE re-transmit interval period in seconds.
Default value is 10 seconds.
ikeRetrasmitC N/A
ount
Specifies the number of re-transmitted IKE. Default value is
3.
certificate
N/A
Specifies the collection of certificates configured on SBC
5x00.
fileName
N/A
Specifies the certificate of content file name
passPhrase
N/A
Specifies the pass-phrase to decrypt RSA private key in
PKCS12 file.
state
N/A
Specifies the administration state of this certificate. Options
are:
• disabled - Prohibits the PKI certificate from being used by
the SBC 5x00 for authenticating remote peers (when this is a
remote certificate) OR presenting its own identity (in case of a
local certificate).
• enabled - Certificate can be used by SBC 5x00 for
authentication purposes.
type
N/A
Specifies the type of the certificate - CA (remote) certificate
or local certificate. Options are:
• local - PKCS#12 formatted certificate is used by the SBC
5x00, while providing its own credentials to a TLS peer.
• remote - DER formatted certificate installed on the SBC 5x00
that is used to authenticate TLS peers.
displaylevel 1-64
command.
Command Example
To display security management configuration:
pki {
certificate cert2 {
fileName file1;
type
7–60
local;
Security Management
System
}
}
7–61
System
Server Administration
This object allows you to manage each server module and set coredump server
profile.
Command Syntax
% set system serverAdmin <serverName> coredumpProfile
default role <role>
% show system serverAdmin
coredumpProfile
role <role>
% delete system serverAdmin
Command Parameters
TABLE 7–17 Server Administration Parameters
Parameter
Field
Length
Description
serverName
N/A
Specifies unique name of the server.
role
N/A
Specifies the server module.
• primary - is the one that handles SS7 group messages.
displaylevel 1-64
command.
Command Example
To display server administration configuration:
% show system serverAdmin
serverAdmin merc {
coredumpProfile default;
role
7–62
primary;
System
}
7–63
System
7–64

SBC 5x00 3.0 CLI Reference Guide

Transcription

Similar documents

a flyer on making the transition to IP

issue 52

CV News August 2006

Convergence Challenges for the SME

Untitled - EXCELIA HIFI

Sonus faber Il Cremonese

Manufacturing Energy Management Solution (MEMS)

Cybex Trazer

Sonus Faber.EN_mr_NEU.indd

Greater Cincinnati Water Works Filter Distribution