Attachment 7 SBC 5x00 CLI Reference Guide

CLI Reference Guide
Session Border Controller 5x00
Sonus Technical Publication

www.sonus.net
Sonus Part Number:

Document Version:
Software Version:
550-05505
1
V03.01.00
Copyright
Copyright 1999 - 2013 Sonus Networks, Inc. All rights reserved.
This item and the information contained herein are the property of Sonus Networks, Inc. (Sonus). 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 (the University). 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 Networks, Inc.
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, GSX9000, GSX4000, GSX4010, SBC 5100, SBC 5200, NBS9000, NBS4000, NBS4010, VOICE SENTRY, IMX,
CONNEXIP, NETASSURE, NETENG, NETSCORE, and MOBILEDGE are either registered trademarks or trademarks of Sonus Networks,
Inc. The Sonus Networks, Inc. trademarks may not be used in connection with any product or service that is not Sonus in any manner that is
likely to cause confusion among customers or in any manner that disparages or discredits Sonus Networks, 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 users 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Whats in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Documentation Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Technical Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Chapter 1 Introduction to CLI Commands

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Logging into/Exiting the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Logging In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Exiting the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
SBC 5x00 CLI Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

System Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Configure Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Exclusive Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Private Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
CLI Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6

Command Line Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Uppercase and Lowercase Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Space-Completion Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Chapter 2 System-Level CLI Operations

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
change-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
550-05505 Version 1 Release V03.01.00
Iv
CLI Reference Guide

TOC
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
request addressContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
request alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
request global. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
request message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
request oam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
request system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
set-path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
show cli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
show configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
show notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30
show table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-133
show users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-153
show utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-154
source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-155
top. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-155
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-155
Chapter 3 Configure CLI Operations

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configure Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
revert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
I vi
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.
CLI Reference Guide

TOC
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
top. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Chapter 4 Address Context

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Diameter Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
DNS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

Creating and Configuring DNS Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Configuring DNS A/SRV and NAPTR Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
IP Access Control List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
System ACL Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
IP Interface Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
IPsec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Link Detection Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

I vii
CLI Reference Guide

TOC
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
Link Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-49
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50
NAT Direct Media Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-61

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-61
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
RTP Server Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64

Static IP Routes for IP interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-65
Static Route for Management Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-66
Zone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67
cac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71
dnsGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
gwSigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
gwTrunkGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
h323SigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
h323TrunkGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81
id. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
I viii
CLI Reference Guide

TOC
ipPeer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-95
messageManipulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
remoteDeviceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
sipSigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
sipTrunkGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-99
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-99
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-106
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-129
Chapter 5 Global
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
CAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Call Trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Country . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
License. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29

I ix
CLI Reference Guide

TOC

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Monitor Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Monitor Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
NPA/Nxx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
QoE Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Configuring Gateway Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Configuring H.323 Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Configuring SIP Peer Overload Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Configuring SIP Signaling Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Ix
CLI Reference Guide

TOC
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
SIP Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
Chapter 6 Operations and Maintenance (OAM)

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Configuring Admin (Call CDR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Configuring External CDR Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Configuring Radius Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Filter Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Filter Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Subsystem Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Type Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
I xi
CLI Reference Guide

TOC

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Local Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Radius Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
SNMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Chapter 7 Profiles
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Call Parameter Filter Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Crankback Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Element Routing Priority Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Holiday . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Time Range Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Digit Parameter Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

I xii
CLI Reference Guide

TOC
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

DM/PM Criteria Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DM/PM Rule Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Number Translation Criteria Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Numbering Plan Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prefix Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7-18
7-22
7-29
7-30
7-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-33
Digit Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40
DTMF Trigger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-43
Feature Control Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
IP Signaling Peer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-46
Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-47
Announcement Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-47
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-47
Codec Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58
Transcoding Configuration Command Example 58

Media QoS KPI Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
Packet Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-61
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-61
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-70
Tone and Announcement Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-71
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-71

I xiii
CLI Reference Guide

TOC
Tone Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-73

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
Tone Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-76
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-76
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Crypto Suite Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-81
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Key Management Protection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
IPSec Protection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
TLS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-86
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-86
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-88
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Class of Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Dynamic Blacklist (DBL) Policer Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Disconnect Signaling Sequence Profile (SSP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-93
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-93
Disconnect Treatment Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-95
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-95
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Emergency Call Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
I xiv
CLI Reference Guide

TOC

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Path Check Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-99
SIP ARS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
SIP Security Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-104
Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
X-Header Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
IP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-111
H.323 Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
SIP Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-118
ISUP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-158
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-158
Number Globalization Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-203
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-203
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-208
SCTP Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-209
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-209
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-210
Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-212
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-212
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Signaling QoS KPI Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-234
SIP Adaptor Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-235
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-235
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-246

I xv
CLI Reference Guide

TOC
SIP/CPC Cause Code Mapping Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-248

CPC to SIP Cause Map Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-249
Internal SIP Cause Map Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-251
SIP to CPC Cause Code Mapping Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-252
SIP CAC Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-256

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-256
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-259
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-263
System Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-265

Coredump Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-265
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-265
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
IP Policing Alarm Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-270
Overload Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-273
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-273
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-275
Chapter 8 System
Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Set Command Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Request Command Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Congestion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Congestion Policer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
DSP PAD Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13

Media Performance Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Playout Time Series Period and Thresholds . . . . . . . . . . . . . . . . . . .
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8-14
8-15
8-15
8-16
8-18
Ethernet Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
I xvi
CLI Reference Guide

TOC
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
Interval Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
IP Policing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Juniper SRC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
Logical Management IP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29
Media Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Management IP Interface Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35
Management Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-41
NTP Services Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-42

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-42
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-44
Policy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45

Global Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-46
I xvii
CLI Reference Guide

TOC
Local Policy Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-47

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-47
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-48
Remote Policy Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Security Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52

IPSec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52
PKI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-53
Local Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remote Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8-53
8-53
8-54
8-54
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-55
Server Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-56

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-56
Set Command Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-56
Request Command Paramters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
I xviii
LIST OF TABLES
TABLE 2 1 request addressContext cmds optionsPing Parameters . . . . . . . . . . . . . . . . . . . 2-6

TABLE 2 2 dnsGroup request Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
TABLE 2 3 dynamicBlackList request Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
TABLE 2 4 ipsec request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
TABLE 2 5 sipRegistrationAdaptiveNatLearning request Parameters . . . . . . . . . . . . . . . . . . 2-8
TABLE 2 6 sipRegistrationDeleteById request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
TABLE 2 7 sipRegistrationDeleteByIp request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
TABLE 2 8 sipSubCountReset request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
TABLE 2 9 sipSubscriptionDelete request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
TABLE 2 10 request addressContext zone Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
TABLE 2 11 request global Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
TABLE 2 12 request system admin Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
TABLE 2 13 set Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
TABLE 2 14 CLI History Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
TABLE 2 15 show status addressContext Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34
TABLE 2 16 show status addressContext ipsec Parameters . . . . . . . . . . . . . . . . . . . . . . . 2-47
TABLE 2 17 show status addressContext zone Parameters . . . . . . . . . . . . . . . . . . . . . . . 2-50
TABLE 2 18 show status alarms Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-78
TABLE 2 19 show status global Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-86
TABLE 2 20 show status global globalTrunkGroupStatus Parameters . . . . . . . . . . . . . . . 2-94
TABLE 2 21 show status global policyServer dnsEnumCounters Parameters. . . . . . . . . . 2-95
TABLE 2 22 show status global policyServer policyRegCounter Parameters . . . . . . . . . . 2-97
TABLE 2 23 show status global policyServer serviceUsageCounters Parameters . . . . . . 2-98
TABLE 2 24 show status oam Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-103
TABLE 2 25 show status system Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-115
TABLE 4 1 Diameter Node Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
TABLE 4 2 DNS Group Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
TABLE 4 3 Intercept Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
TABLE 4 4 IP Access Control List Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
TABLE 4 5 System ACL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
TABLE 4 6 IP Interface Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
TABLE 4 7 IPSec Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
TABLE 4 8 SPD Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
TABLE 4 9 IPSec SA Delete Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
TABLE 4 10 Link Detection Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
TABLE 4 11 Link Monitor Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-49
TABLE 4 12 NAT Direct Media Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
TABLE 4 13 RTP Server Table Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
I xix
CLI Reference Guide

TOC
TABLE 4 14 Static Route Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64

TABLE 4 15 Zone CAC Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72
TABLE 4 16 Zone DNS Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
TABLE 4 17 Zone Gateway Signaling Port Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
TABLE 4 18 Zone Gateway Trunk Group Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-77
TABLE 4 19 Zone H.323 Signaling Port Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
TABLE 4 20 Zone H.323 Trunk Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-84
TABLE 4 21 Zone ID Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
TABLE 4 22 Zone IP Peer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
TABLE 4 23 Zone Message Manipulation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
TABLE 4 24 Zone Remote Device Type Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
TABLE 4 25 Zone SIP Signaling Port Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-98
TABLE 4 26 Zone SIP Trunk Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-106
TABLE 4 27 SIP Trunk Group Early Media Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 4-129
TABLE 5 1 Global CAC Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
TABLE 5 2 Global Call Routing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
TABLE 5 3 Global Call Trace Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
TABLE 5 4 Global Call Trace Call Filter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
TABLE 5 5 Global Carrier Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
TABLE 5 6 Global Country Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
TABLE 5 7 Global License Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
TABLE 5 8 Global Monitor Endpoint Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
TABLE 5 9 Global Monitor Target Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
TABLE 5 10 Global NPA/Nxx Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
TABLE 5 11 Global QoE Call Routing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
TABLE 5 12 Global Script Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
TABLE 5 13 Global Security Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
TABLE 5 14 Global DNS Servers Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
TABLE 5 15 Global Gateway Signaling Timers Parameters . . . . . . . . . . . . . . . . . . . . . . . . 5-43
TABLE 5 16 Global H.323 Signaling Timers Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
TABLE 5 17 Global SIP Peer Overload Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . 5-46
TABLE 5 18 Global SIP Signaling Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
TABLE 5 19 Global SIP Domain Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
TABLE 5 20 Global Subscriber Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
TABLE 6 1 CDR Admin Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
TABLE 6 2 External CDR Server Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
TABLE 6 3 OAM Accounting Radius Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
TABLE 6 4 IP Policing Alarm Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
TABLE 6 5 Alarm Request Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
TABLE 6 6 Filter Admin Event Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
TABLE 6 7 Filter Status Event Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
TABLE 6 8 Subsystem Admin Event Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
TABLE 6 9 Type Admin Event Log Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
I xx
CLI Reference Guide

TOC
TABLE 6 10 Local Authentication Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25

TABLE 6 11 Radius Authentication Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
TABLE 6 12 SNMP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
TABLE 6 13 OAM Trap Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
TABLE 7 1 Call Parameter Filter Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
TABLE 7 2 Crankback Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
TABLE 7 3 Element Routing Priority Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
TABLE 7 4 Holiday parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
TABLE 7 5 Time Range Profile Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
TABLE 7 6 DM/PM Criteria Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
TABLE 7 7 DM/PM Rule Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
TABLE 7 8 Sub-rule Rule Type Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27
TABLE 7 9 Number Translation Criteria Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29
TABLE 7 10 Numbering Plan Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-30
TABLE 7 11 Prefix Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
TABLE 7 12 Digit Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37
TABLE 7 13 DTMF Trigger Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
TABLE 7 14 Feature Control Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
TABLE 7 15 IP Signaling Peer Group Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45
TABLE 7 16 Announcement Package parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-48
TABLE 7 17 Codec Entry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
TABLE 7 18 Media QoS KPI Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-60
TABLE 7 19 Packet Service Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-63
TABLE 7 20 Tone and Announcement Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . 7-72
TABLE 7 21 Tone Package Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
TABLE 7 22 Tone Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-77
TABLE 7 23 Crypto Suite Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-81
TABLE 7 24 Key Management Protection Profile Parameters. . . . . . . . . . . . . . . . . . . . . . . 7-83
TABLE 7 25 IPSec Protection Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
TABLE 7 26 TLS Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
TABLE 7 27 Class of Service Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-90
TABLE 7 28 DBL Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-92
TABLE 7 29 Disconnect SSP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-94
TABLE 7 30 Disconnect Treatment Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
TABLE 7 31 Emergency Call Profile Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
TABLE 7 32 Path Check Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
TABLE 7 33 SIP ARS Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
TABLE 7 34 SIP Security Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
TABLE 7 35 X-Header Profile Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-108
TABLE 7 36 X-Header Parameter Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-110
TABLE 7 37 IP Signaling Profile H.323 Common IP Attributes . . . . . . . . . . . . . . . . . . . . . 7-112
TABLE 7 38 IP Signaling Profile H.323 Egress IP Attributes . . . . . . . . . . . . . . . . . . . . . . . 7-115
TABLE 7 39 IP Signaling Profile H.323 Ingress IP Attributes flags . . . . . . . . . . . . . . . . . . 7-116
I xxi
CLI Reference Guide

TOC
TABLE 7 40 IP Signaling Profile H.323 IP Protocol Type . . . . . . . . . . . . . . . . . . . . . . . . . 7-117

TABLE 7 41 IP Signaling Profile SIP Common IP Attributes . . . . . . . . . . . . . . . . . . . . . . . 7-122
TABLE 7 42 IP Signaling Profile SIP Egress IP Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
TABLE 7 43 IP Signaling Profile SIP Ingress IP Attributes . . . . . . . . . . . . . . . . . . . . . . . . 7-153
TABLE 7 44 IP Signaling Profile SIP IP Protocol Type Parameters. . . . . . . . . . . . . . . . . . 7-157
TABLE 7 45 ISUP Signaling Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-167
TABLE 7 46 Number Globalization Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-205
TABLE 7 47 SCTP Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-210
TABLE 7 48 Signaling Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-216
TABLE 7 49 Signaling QoS KPI Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-233
TABLE 7 50 SIP Adaptor Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-238
TABLE 7 51 SIP Adaptor Profile Rule Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-238
TABLE 7 52 CPC SIP Cause Code Mapping Profile Parameters . . . . . . . . . . . . . . . . . . . 7-250
TABLE 7 53 Internal SIP Cause Mapping Profile Parameters . . . . . . . . . . . . . . . . . . . . . . 7-252
TABLE 7 54 SIP to CPC Cause Code Mapping Profile Parameters . . . . . . . . . . . . . . . . . 7-253
TABLE 7 55 SIP CAC Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-259
TABLE 7 56 Coredump Profile parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-265
TABLE 7 57 IP Policing Alarm Profile Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-267
TABLE 7 58 Overload Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-274
TABLE 8 1 System Admin Parameters (Set) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
TABLE 8 2 System Admin Parameters (Request) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
TABLE 8 3 System Congestion Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
TABLE 8 4 Threshold Comparison. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
TABLE 8 5 DSP Pad Resources Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
TABLE 8 6 Ethernet Port Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
TABLE 8 7 Interval Statistics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
TABLE 8 8 System IP Policing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
TABLE 8 9 JSRC Server Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
TABLE 8 10 Interval Statistics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
TABLE 8 11 Media Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29
TABLE 8 12 Media Profile Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
TABLE 8 13 Management IP Interface Group Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 8-34
TABLE 8 14 Management Static Route Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40
TABLE 8 15 NTP Services Management Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-43
TABLE 8 16 System Policy Server Global Configuration Parameters . . . . . . . . . . . . . . . . . 8-46
TABLE 8 17 Local Policy Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . 8-47
TABLE 8 18 Remote Policy Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . 8-49
TABLE 8 19 Security Management Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-53
TABLE 8 20 Security Management Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-54
TABLE 8 21 System Server Admin Parameters (set command) . . . . . . . . . . . . . . . . . . . . . 8-56
TABLE 8 22 System Server Admin Parameters (request) . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
I xxii
About This Guide
Overview
The Sonus SBC 5x00 CLI Reference Guide describes how to use the Sonus
Command Line Interface (CLI) to configure and manage the SBC 5x00 switch.
Audience
This guide is intended for network engineers responsible for provisioning,
maintaining, and administering the SBC 5x00 Session Border Controllers. The
user should posses a working knowledge of the Public Switched Telephone
Network (PSTN), the UNIX operating system, and packet networking.
I xxiii
CLI Reference Guide
Whats in This Guide
This guide contains the following information:

Chapter 1, "Introduction to CLI Commands", provides an overview of the CLI
components documented in this guide.
Chapter 2, "System-Level CLI Operations", 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, "Configure CLI Operations", provides information on the operations
associated with the SBC 5x00 Configure CLI mode, including command syntax,
parameters and attributes, and command examples.
Chapter 4, "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 5, "Global", presents a description of global object and the CLI
commands that you may use to create, configure, and view information about it.
Chapter 6, "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 7, "Profiles", presents a description of profiles object and the CLI
Chapter 8, "System", presents a description of system object and the CLI
Documentation Updates
For updates to Sonus Technical Publications media and documents, see
http://www.sonus.net/technical-publications.
Navigate to the What's New in Sonus Documentation topic to view new and
revised Sonus technical documentation:
http://www.sonus.net/techpub-whats-new
NOTE
Subscribe to the What's New in Sonus Documentation RSS feed to

get a documentation update notification delivered directly to your
desktop using a reader application.
I xxiv

CLI Reference Guide
Related Documentation
Other documents in the SBC 5x00 product family include:
SBC 5x00 EMA User Guide (550-05517)Provides the complete set of

operational instructions for the Embedded Management Application (EMA)
Web-based GUI interface such as configuration, fault, performance, and
security management functions.
SBC 5x00 Software Installation Guide (550-05509)Describes the SBC
5x00 software installation and upgrade processes for the application, BMC
firmware, BIOS firmware and operating system.
SBC 5x00 Hardware Installation Guide (550-05506)Provides
comprehensive steps to mount the SBC 5x00 chassis into a rack, connect
cabling and powering up the platform in preparation for installing the software.
SBC 5x00 Platform Manager User Guide (550-05516)Describes the
operation and use of the Platform Manager web interface to perform activities
such as network administration, troubleshooting, license install, security,
remote user activities, rebooting, log management, OS upgrades and more.
SBC 5x00 Alarms and Troubleshooting Guide (550-05504)Provides
detailed alarm and event information related to SBC 5x00 to aid in isolating
and troubleshooting system fault conditions.
SBC 5x00 MIB Reference (550-05514)Lists the MIBs supported by the
SBC 5x00 platform.
SBC 5x00 Release Notes (550-05513)Describes new features, new
hardware and software requirements, and known limitations for the latest SBC
5x00 release.
SBC 5x00 Operations Guide (550-05503) Provides guidance with
configuring, operating, and maintaining SBC 5x00.
SBC 5x00 Applications Guide (550-05502) Provides an in-depth
description of the SBC 5x00 architecture and feature set, including various
deployment scenarios.
Customer Replaceable Unit (CRU) documentation for fan, power supplies
SFPs, bezel, and SSD.
SBC 5x00 application notesIOT application notes for third-party products.
SBC 5x00 Software Installation Quick Reference (50-05510)A
condensed version of the software installation guide for use as a quick
reference.
SBC 5x00 Hardware Installation Quick Reference (550-05476)A
condensed version of the SBC 5x00 hardware installation guide for use as a
quick reference.
SBC 5x00 Remote Access Quick Start (550-05748)Provides instructions
on configuring SBC 5x00 with basic network interface information and
configuring SecureLink application to allow Sonus personnel to remotely set
up your SBC platform.

I xxv
CLI Reference Guide
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 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:
text
Followed by bold
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 xxvi

CLI Reference Guide
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-8904
Web
http://www.sonus.net/company/maintenance/log-trouble-tickets
Technical Publications
Customer comments are welcome. If you have questions or comments about this
document, please address your feedback as follows:
E-mail: TechnicalPublications@sonusnet.com
Address:
Sonus Networks, Inc.
Attn: Technical Publications
4 Technology Park Drive
Westford, MA 01886
USA

I xxvii
CLI Reference Guide
I xxviii

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 available in
each mode. Topics include:
"Logging into/Exiting the CLI" on page 1 2

"SBC 5x00 CLI Modes" on page 1 3
"CLI Operation" on page 1 6
"Getting Help" on page 1 8
11
CLI Reference Guide

Logging into/Exiting the CLI
Logging into/Exiting the CLI
Logging In
Perform the following steps to login to SBC 5x00 CLI at System level:
Logging into the CLI
1.
SSH to the active CE. For example, if the active CE is server1, enter:
ssh admin@server1
Local nodes are instantiated on one or more hardware entities called Computing
Element (CE) within an SBC 5x00.
2.
When prompted, enter login ID and password. The default login and password name
is admin.
login as: admin
admin@10.1.1.19s password: *****
A message similar to the following appears:
admin connected from 10.1.1.19 using ssh on server1
admin@server1>
Exiting the CLI

To exit the System-level CLI, type exit at the prompt. For example,
admin@server1> exit
Depending upon your method to access CLI, either a message similar to the
following appears or your terminal session closes.
Connection to server1 closed
12

CLI Reference Guide

SBC 5x00 CLI Modes
SBC 5x00 CLI Modes
The SBC 5x00 CLI includes two modes:
System modeThis is the mode when you first login to CLI, and is used to
view the current configuration and status of objects.
Configure modeUse this mode to create, modify, view, and delete

configurable SBC 5x00 objects.
System Mode
The following system operations are available from the top-level (System)
CLI mode:
change-password Change your password

commit Confirm a pending commit
configure Switch to Configure mode to provision the system.
exit Exit the management session
help View 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 View information about the system
source Select a CLI configuration file to load
top Exit to top level and optionally run command
up Exit one level of configuration

13
CLI Reference Guide

SBC 5x00 CLI Modes
Configure Mode
To access Configure mode, enter the following command from CLI prompt:
admin@Hackos> configure <exclusive|private>
...where <exclusive|private> represents the type of configuration access for
the session, either Exclusive or Private. If you enter configure with no
argument, the system defaults to the Private session.
The following operations are supported in both Exclusive and Private sessions:
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 Exit from this level
revert Remove latest uncommitted configuration changes from memory
rollback Roll back database to last committed version
set Set a parameter
show Show a parameter
status Display users currently editing the configuration
To exit Configure mode, enter either quit or exit.
Exclusive Session
Allows a user to exclusively configure the system via CLI. Only one exclusive
session is possible at a time. An exclusive session cannot start if a private session
is in the process of committing changes. Below is an example of setting configure
mode to exclusive.
admin@Hackos> configure exclusive
Entering configuration mode exclusive
Warning: uncommitted changes will be discarded on exit
[ok][2012-07-05 01:53:11]
[edit]
admin@Hackos%
NOTE
Uncommitted changes are discarded upon exit from Configure mode.

14

CLI Reference Guide

SBC 5x00 CLI Modes
Private Session
Multiple private sessions can occur simultaneously. Changes made in a private
session can be committed to update the current configuration while other private
sessions are open.
Private sessions are allowed concurrently with an exclusive session, but private
session users cannot commit their changes until the exclusive session ends.
NOTE
A total of six simultaneous sessions are allowed at one time (including

the exclusive session).
Here is an example of setting the session to private:
admin@Hackos> configure private
Entering configuration mode private
[ok][2009-01-05 17:06:22]
[edit]
admin@server1%
NOTE
Uncommitted changes are discarded upon exit from Configure mode.

15
CLI Reference Guide

CLI Operation
CLI Operation
Command Line Structure

A CLI command is composed of the following elements:
<operation> <object> <keyword> <parameter1> <attribute/
argument> <parameter2> <attribute/argument>...
Where:
<operation> is the operation to be performed.
<object> is the object on which to perform the operation.
<keyword> is the string or strings that uniquely identify the object. A command
may have more than one keyword value.
<parameter> is the child object of the main object. More than one parameter
may be included in the command.
<attribute> is the value or argument associated with the parameter.
For example, to enable a SIP trunk group named STG-1 in the zone named
defaultSigZone for the default address context, the following command applies
(refer to Figure 1 1):
set addressContext default zone defaultSigZone sipTrunkGroup
STG-1 state enabled
FIGURE 1 1 CLI Command Line Structure
set addressContext default zone defaultSigZone sipTrunkGroup STG-1 state enabled

Operation
(verb)
Object
Keyword
Parameter
Attribute
Parameter
Attribute
Parameter
Attribute
Uppercase and Lowercase Use

CLI commands are case-sensitive and must be entered exactly as shown in this
guide. Objects and profiles with names that differ only in case are considered
distinct objects.
For example, the following profile names are considered three distinct entities:
SIP_IPSP, Sip_Ipsp, sip_ipsp. It is strongly recommended to adopt a standard
naming convention when initially defining your configuration.
NOTE
As a best practice, always use UPPERCASE for trunk group names.

16

CLI Reference Guide

CLI Operation
Space-Completion Functionality
The CLI includes space-completion behavior which automatically displays a list of
possible arguments when the user types more than one space after a keyword or
parameter (same action as pressing Tab). This default setting is generally desired
behavior when entering commands from an interactive session (complete-onspace is set to true).
The commands to turn on/off space-completion are:
set complete-on-space true

set complete-on-space false
Here is an example of entering show command plus two spaces when spacecompletion is set to true. The result is a Possible completions list that
automatically displays as shown:
admin@sbx131> show..
Possible completions:
cli
- Display cli settings
configuration - Display current configuration

notification
- Display notifications
status
- Display current system status
table
a table
- Display current configuration and status as
users
- Display currently logged on users
utils
- System utilities
On the other hand, when copy-pasting multiple commands to the command line
this feature is not desirable. Extra spaces may prevent the commands from
running as expected due to the automatic space-completion feature. To avoid this,
turn this feature off using the following command:
admin@sbx131> set complete-on-space false
[ok][2012-07-03 14:13:47]

17
CLI Reference Guide

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 available System-level CLI commands, at the CLI prompt (for example,
admin@server1>), type ?.
A list of the possible System-level commands appears:
change-password - Change your password
18
commit
- Confirm a pending commit
configure
information
- Manipulate software configuration
exit
- Exit the management session
help
- Provide help information
quit
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
command
- Exit to top level and optionally run
up
- Exit one level of configuration

CLI Reference Guide

Getting Help
Getting Help in the CLI (Continued)

2.
To see the possible entries that can come next in a System-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 displays:
addressContext - Objects scoped to a specific IP
addressing domain.
details
- Show details.
displaylevel
- Depth to show.
global
wide.
- Global objects that are applicable Node
oam
- Operations and Maintenance objects.
profiles
- Profiles of configuration shared by
multiple objects.
system
- System-level configuration.
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 displays:
commit
- Commit current set of changes
delete
- Delete a data element
edit
- Edit a sub-element
exit
- Exit from this level
help
quit
- Exit from this level
request
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

19
CLI Reference Guide

Getting Help
Getting Help in the CLI (Continued)

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 displays:
addressContext - A container of objects that correspond
to
a specific IP Addressing domain.
global
- Global objects that are applicable Node

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 Tab key. The following displays:
callRouting - Global call routing objects.
callTrace
- Call Trace Group configuration for the Node.
carrier
- Carrier definitions.
country
- Country definitions.
npaNxx
- Npa Nxx.
script
- Default scripts for call control.
security
- Global security objects.
servers
- Global server objects.
signaling
- Global Signaling objects.
sipDomain
- SIP Domain.
subscriber
- Subscriber.
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 displays
callFilter
filters for the node.
errorFilter
wide.
- This table contains call trace

- The error filter to apply system
maxTriggerCount
- The trigger count for both call
and error trace filters.
signalingPacketCapture - Enable/disable signaling packets
capture.
1 10

CLI Reference Guide

System-Level CLI Operations
CHAPTER 2
Overview
This chapter provides information on the operations associated with the SBC
5x00 system-level CLI mode, including command syntax, parameters and
attributes, and command examples.
To see available system CLI commands, at the CLI prompt, type ?. A list of
available system commands display similar to below:
admin@merc> ?
change-password Change your password
commit
Confirm a pending commit
configure Manipulate software configuration information

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
- Exit to top level and optionally run command
up
Command details are explained in the following sub-sections.

21
CLI Reference Guide

System Commands
System Commands
This section defines the command syntax, parameters and command examples of
the following system CLI commands.
22
"change-password" on page 2 3
"commit" on page 2 3
"configure" on page 2 4
"exit" on page 2 4
"help" on page 2 5
"quit" on page 2 5
"request" on page 2 5
"reset" on page 2 17
"set" on page 2 17
"set-path" on page 2 19
"show" on page 2 19
"source" on page 2 155
"top" on page 2 155
"up" on page 2 155

CLI Reference Guide

System Commands
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
Command Example
> change-password
Enter old password: *********
Enter new password: **********
Re-enter new password: **********
passwd: password updated successfully
commit
If you are issuing a set, edit or delete command in the system CLI mode or
configuration mode, you need to perform a commit for the changes to take effect.
A commit is not required for a request command in the system 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.
Command Syntax
> commit
abort
confirm
persist-id <id>

23
CLI Reference Guide

System Commands
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 are modified.
configure
The Configure mode lets you create or modify, show, and delete configurable SBC
5x00 objects. Two modes are available:
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.
Enter configure with no arguments to select the default private mode.
Command Syntax
> configure <exclusive|private>
Command Example
To configure SBC 5x00 in private mode:
admin@server1> configure private
Entering configuration mode private
[ok][2012-04-26 01:33:15]
[edit]
admin@server1%
NOTE
Maximum of six simultaneous sessions can be opened at a time

including exclusive session.
exit
Use the exit operation to exit from the CLI management session.
24

CLI Reference Guide

System Commands
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 8.
quit
Use quit to exit the system CLI management session.
request
The request operation facilitates system-level requests for the following objects:
request addressContext Objects scoped to a specific IP address domain.

request alarms Alarm Management
request global Global objects that are applicable Node wide
request message Send a message to one or all user terminals
request oam Operations and Maintenance objects.
request system System operations
request addressContext
The request addressContext command uses the following objects:
cmds Incorporates SIP options ping feature.

dnsGroup DNS Server Groups in this address context.
dynamicBlackList The collection of DBL policers.
ipsec Ipsec configuration, security policy database, ike peer table.
sipRegCountReset Resets the SIP registration count.
sipRegistrationAdaptiveNatLearning reset/disable adaptive nat
pinhole learning process.
sipRegistrationDeleteById Delete a SIP registration by ID.
sipRegistrationDeleteByIp Delete a SIP registration by IP address.
sipSubCountReset Reset the SIP subscription count.
sipSubscriptionDelete Delete a SIP subscription.
zone Signaling, media, and control for a zone in the address context.
cmds optionsPing
Command syntax to ping another system from SBC 5x00:

25
CLI Reference Guide

System Commands
> request addressContext <addressContext name> cmds

optionsPing
peerIpAddress <peer ip address>
peerPort <SIP port number>
sigPort <signaling port>
transport <tcp|tls|udp>
TABLE 2 1
Parameter
request addressContext cmds optionsPing Parameters

Length/
Range
addressContext 1-23
N/A
cmds
Description
Name of the address context. The address context is a container of
objects that correspond to a specific IP Addressing domain.
The commands object used to perform optionsPing actions.
optionsPing Use to ping a SIP peer using SIP OPTIONS method.
peerIpAddress The IPv4 or IPv6 Peer SIP Address to ping.
peerPort The Peer SIP Port Number to ping. (Default = 5060)
sigPort The Signaling Port number to use for the ping.
transport The Transport protocol. Select any one of the following
transport types:
tcp
tls
udp (Default)
dnsGroup
Command syntax to initiate action on DNS group object:
> request addressContext <addressContext name> dnsGroup
<dnsGroup name> dnsServerReset
TABLE 2 2
Parameter
dnsGroup request Parameters

Length/
Range
addressContext 1-23
dnsGroup
1-23
dnsServerReset N/A
Description
Name of this DNS Group Entry.
Resets all the DNS server statistics.
dynamicBlackList
This object allows you to remove Dynamic Blacklist (DBL) entries for the specified
IP address.
Command Syntax
26

CLI Reference Guide

System Commands
> request addressContext <addressContext name>

dynamicBlackList removeEntry sourceIpAddress <ip address>
TABLE 2 3
dynamicBlackList request Parameters
Parameter
Length/
Range Description
addressContext
1-23
dynamicBlackList N/A

Collection of DBL policers.
removeEntry
N/A
Parameter to remove any DBL entries for specified IP address.
sourceIpAddress
32
Enter IP address from which to remove DBL entries.
Example
The following command removes all DBL entries from IP address 10.10.123.8:
> request addressContext default dynamicBlackList
removeEntry sourceIpAddress 10.10.128.8
When prompted, enter y to continue:
This command will remove any DBL entry with a matching source
IP address. Do you want to proceed (yes/no) y
ipsec
Command syntax to initiate action on IPsec object:
> request addressContext <addressContext name> ipsec <ipsec
parameter to delete>
TABLE 2 4
ipsec request Parameters
Parameter
Length/
Range
addressContext 1-23
Description
ipsec
N/A
IP Security configuration, including security policy database and IKE

peer table.
ikeSaDelete
N/A
Name of a specific IKE SA to be deleted by its IKE handle identifier.

saIndex <unsignedInt> index number of IKE SA to delete.
ikeSaDeleteAll N/A
ipsecSaDelete
N/A
Globally deletes all IKE SAs. When prompted to delete all, enter Yes.
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).
localSPI <sonusHexBinary value> Local SPI (Security
Parameter Index) of the SA to delete.
Examples
The following command deletes all entries from the IKE SA list for local SPI 13:
27
CLI Reference Guide

System Commands
> request addressContext default ipsec ikeSaDelete saIndex

13
When prompted, enter y to continue:
This command will delete entry from the IKE SA list. Do you
want to continue (yes/no) y
sipRegCountReset
This object resets thte SIP registration count.
Command Syntax
sipRegCountReset
Example
The following example resets SIP registration count for address context default:
> request addressContext default sipRegCountReset
result success
reason Registration Count is Reset
sipRegistrationAdaptiveNatLearning
This object provides flexibility to disable/reset adaptive NAT pinhole learning
process for a specific user already registered with SBC 5x00.
Command Syntax
sipRegistrationAdaptiveNatLearning
action <disable|reset>
id <registration id nbr>
TABLE 2 5
sipRegistrationAdaptiveNatLearning request Parameters
Parameter
Length/
Range
addressContext
1-23
sipRegistrationAdaptive N/A
NatLearning
N/A
id
Description
Name of the address context. The address context is a
container of objects that correspond to a specific IP
Addressing domain.
Reset/disable adaptive NAT pinhole learning process.
Registration ID of user.
<id number>
action
N/A
Action to perform. Arguments include:

disable
reset
Example
28

CLI Reference Guide

System Commands
The following example disables the NAT pinhole learning process for registered
user with an ID of 13:
> request addressContext default
sipRegistrationAdaptiveNatLearning id 13 action disable
sipRegistrationDeleteById
This object allows you to delete a SIP registration by the users ID number.
Command Syntax
sipRegistrationDeleteById id <registration id>
TABLE 2 6
sipRegistrationDeleteById request Parameters
Parameter
Length/
Range Description
addressContext
1-23
sipRegistrationDeleteById N/A
N/A
id

Addressing domain.
Delete SIP registration for the specified ID.
Registration ID of user.
<id number>
NOTE
The surrogate registration is not deleted by the following command.

Example
> request addressContext default sipRegistrationDeleteById
id 13
result success
sipRegistrationDeleteByIp
This object allows you to delete a SIP registration by the IP address using the
Registrars IP address (found in sipActiveGroupRegStatus table).
Command Syntax
sipRegistrationDeleteByIp ipAddress <ip address>

29
CLI Reference Guide

TABLE 2 7
System Commands
sipRegistrationDeleteByIp request Parameters
Parameter
Length/
Range Description
addressContext
1-23
sipRegistrationDeleteByIp N/A
N/A
ipAddress

Addressing domain.
Delete SIP registration associated with the specified IP
address.
IP address of the Registrar.
<ip address>
NOTE
The surrogate registration is not deleted by the following command.

Example
> request addressContext default sipRegistrationDeleteByIp
ipAddress 10.20.128.13
result success
sipSubCountReset
This object resets the SIP subscription count.
Command Syntax
sipSubCountReset
TABLE 2 8
sipSubCountReset request Parameters
Parameter
Length/
Range Description
addressContext
1-23

Addressing domain.
sipSubCountReset
N/A
Reset SIP subscription count.
Example
> request addressContext default sipSubCountReset
result success
reason Subscription Count is Reset
2 10

CLI Reference Guide

System Commands
sipSubscriptionDelete
Command Syntax
sipSubscriptionDelete <subcription id>
TABLE 2 9
sipSubscriptionDelete request Parameters
Parameter
Length/
Range Description
addressContext
1-23

Addressing domain.
sipSubscriptionDelete
N/A
Deletes the specified SIP subscription.
id
N/A
Subscription ID designation.
<subscription id nbr>
Example
> request addressContext default sipSubscriptionDelete id 13
zone
This object allows you to perform system-level commands against a particular
zone, such as recovering blacklisted endpoints and resetting statistics counts on
all signaling ports.
Command Syntax
> request addressContext <addressContext name> zone <zone
name>
ipPeer
sipArsEndpointRecoveryAll
sipArsEndpointRecoveryByIp ipAddress <ip address> port
<port#>
sipSigConnResetAll
sipSigPortResetAll
sipTrunkGroup <TG name> packetOutage clear
TABLE 2 10 request addressContext zone Parameters
Parameter
Length/
Range Description
addressContext
1-23

container of objects that correspond to a specific IP Addressing
domain.
zone
N/A
The zone of interest for the specified address context.
ipPeer
N/A
Static IP peer in the selected zone.
sipArsEndpointRecovery N/A
All
Recovers all blacklisted endpoints in this zone.

NOTE: This command only applies for peers blacklisted
using ARS mechanism (not via PATHCHECK).

2 11
CLI Reference Guide

System Commands
TABLE 2 10 request addressContext zone Parameters (Continued)

Length/
Range Description
Parameter
sipArsEndpointRecovery N/A
ByIp
Recovers a blacklisted endpoints in this zone by IP address and

port. Arguments include:
ipAddress <ip adddress>
port <endpoint port#>
NOTE: This command only applies for peers blacklisted
using ARS mechanism (not via PATHCHECK).
sipSigConnResetAll
N/A
Resets all the statistics counts to zero on all SIP signaling port
connections.
sipSigPortResetAll
N/A
Resets all the statistics counts to zero on all SIP signaling ports.
sipTrunkGroup
N/A
Specify the SIP trunk group for which to clear packet outage
counts. Arguments include:
<TG_NAME>
packetOutage clear
Example
The following example clears packet outage counts for SIP trunk group TG-1 in
zone INTERNAL_ZONE for address context default.
> request addressContext default zone INTERNAL_ZONE
sipTrunkGroup TG-1 packetOutage clear
reason Trunk Group Packet Outage Detection State is cleared
request alarms
Command syntax to clear alarms is listed below.
> request alarms clear <current|history> alarmId <alarm Id>
request global
To initiate action on global object, use following command syntax.
> request global
callCountReset
mediaCapture disabledByGcid gcid <gcid#>
terminateCall GCID <gcid#>.
TABLE 2 11 request global Parameters
Parameter
Length/
Range Description
global
N/A
Global objects applicable node-wide.
callCountReset
N/A
This object resets all statistics counts to zero.
2 12

CLI Reference Guide

System Commands
TABLE 2 11 request global Parameters (Continued)

Parameter
Length/
Range Description
mediaCapture
N/A
Resets call count for media capture with following

arguments:
disabledByGcid
gcid <gcid#> (Range: 0-2147483647)
N/A
terminateCall
Terminates call based on the specified Global Call Identifier

(GCID).
GCID <gcid#>
request message
Use this command to send a message to one or all user terminals.
Command Syntax
> request message
<userid> <message>
all <message>
Example:
Command Example
> request message all please log off immediately
request oam
Use this command to initiate action on accounting objects:
> request oam accounting cdrServer admin
> request oam alarms resetIpPolicingAlarmStatus
> request oam eventLog filterStatus <system name>
audit
debug
security
system
trace

2 13
CLI Reference Guide

System Commands
request system
The request system command applies to both operational and configure
modes except where noted. The following objects apply to this command:
admin
congestion
ipPolicing
logout (operational mode only)
policyServer
serverAdmin
admin
> request system admin <system_name>
commitSoftwareUpgrade
identify
duration <0-255 seconds>
loadConfig
allowOldVersion <no|yes>
fileName <filename>
removeSavedConfig
fileName <filename>
restart
revertSoftwareUpgrade
revertMode <forced|normal>
saveConfig
fileNameSuffix <suffix>
softReset
switchover
TABLE 2 12 request system admin Parameters
Parameter
Length/
Range Description
N/A
Use this command to initiate a software upgrade.
identify
0-255
This object turns on/off the locator LED of the indicated server
(in HA configuration, both servers are affected) for the
amount of time specified in duration parameter.
duration Enter a number in range of 0-255. A duration
of 0 turns off the locator LED and a duration of 255 turns
on the locator LED indefinitely.
2 14

CLI Reference Guide

System Commands
TABLE 2 12 request system admin Parameters (Continued)

Parameter
Length/
Range Description
loadConfig
N/A
Load saved configuration and restart the system without

rebooting the server(s).
allowOldVersion This option is only intended for use
to override checks for older releases which do not identify
their version. In this case, if the follow warning displays,
follow the instructions given:
There is no version identifier on the saved
file. Use the allowOldVersion parameter
only if you are sure the version of the
saved configuration file is compatible with
the running software version.
(see the NOTE below this table for a possible error and
action to take).
no
yes
fileName Name of the configuration file to load.
N/A
removeSavedConfig
Remove a previously-saved configuration from the server.

fileName Name of the configuration file to remove.
restart
N/A
Restart the system (all servers).
N/A
Use this object to revert back to the last live software

upgrade.
revertMode The upgrade mode to execute:
forced Perform software upgrade with no conditions.
normal Perform a normal software upgrade.
N/A
saveConfig
Save the current configuration as a .tar.gz file (binary format)

which can be used if a restore becomes necessary.
fileNameSuffix Enter the configuration filename,
including the suffix.
softReset
N/A
Restart application on the system without rebooting the

server(s).
switchover
N/A
Perform an Active-Standby switchover, and restart all

applications on the currently-active server.
NOTE
If you receive the following error: "reason Configuration file

version not compatible with current software version.
matrixFileNotAvailable", the lswuMatrixSBX5000.bin /
lswuMatrixSBX5000.txt files are missing from the /opt/sonus/
staging directory (upgrade location). To resolve this, copy these files
from /opt/sonus to opt/sonus/staging directory using following
command from Unix shell as root, and then return to SBC CLI and retry
the loadConfig command.
cp /opt/sonus/lswuMatrixSBX5000* /opt/sonus/staging/

2 15
CLI Reference Guide

System Commands
congestion
> request system congestion <congestion_profile>
ipPolicing
> request system ipPolicing resetOffendersList name
aclOffendersList
aggregateOffendersList
arpOffendersList
badEtherIpHdrOffendersList
discardRuleOffendersList
ipSecDecryptOffendersList
mediaOffendersList
rogueMediaOffendersList
uFlowOffendersList
logout
> request system logout user <user_Id>
policyServer
> request system policyServer remoteServer <server_name>
serverAdmin
> request system serverAdmin <server_name>
identify duration <0-255>
removeCoredump coredumpFileName <filename>
restart
softReset
startSoftwareUpgrade
package <pkg_name>
rpmName <rpm/pkg_name>
versionCheck <perform|skip>
2 16

CLI Reference Guide

System Commands
Command Example
To clear all alarms from the history buffer:
admin@server1> request alarms clear history
Deleted all alarm entries in history-table
reset
Use the reset operation to reset the terminal.
set
Use the set operation to make system-level settings for following objects:
autowizard
complete-on-space
display-level
history
ignore-leading-space
output
paginate
prompt1
prompt2
screen
show
terminal
Command Syntax
> set autowizard <true|false>
> set complete-on-space <true|false>
> set display-level <level #>
> set history <size>
> set ignore-leading-space <true|false>
> set output file <terminal|<filename>>
> set paginate <true|false>
> set prompt1 <string
> set prompt2 <string>
> set screen length <positive integer>

2 17
CLI Reference Guide

System Commands
> set screen width <positive integer>

> set show defaults <true|false>
> set terminal <generic|xterm|vt100|ansi|linux>
TABLE 2 13 set Parameters
Parameter
Length/
Range Description
autowizard
N/A
Automatically query for mandatory elements. Options:

true (default)
false
complete-on-space
N/A
Enable/disable complete-on-space feature. See "SpaceCompletion Functionality" on page 1 7 for details.

true (default)
false
display-level
1-64
Set level of detail to view when using show command.

(Default = 99999999)
history
1-8192
Configure CLI history size.

(Default = 100)
ignore-leading-space
N/A
Enable/disable ignore leading whitespace feature.

true (default)
false
output
N/A
Use this parameter to copy CLI output to either the terminal or a

file residing at /home/Administrator. Options:
terminal (default)
<filename>
paginate
N/A
Enable/disable CLI output pagination.

true (default)
false
prompt1
N/A
Set operational mode prompt.
prompt2
N/A
Set configure mode prompt.
screen
N/A
Configure terminal screen height (length) and width.
1-32000 length (default = 62)

width (default = 142)
1-512
N/A
show
Enable/disable displaying default values with show command.

true
false (default)
terminal
N/A
Set the terminal type. Options:
2 18
generic
xterm
vt100
ansi
linux

CLI Reference Guide

System Commands
set-path
The set-path operation is used to set the relative show path for the SBC 5x00
objects.
To view objects to enter next in the set-path command, enter set-path ?
Output similar to the following displays:
addressContext - Objects scoped to a specific IP addressing domain.
alarms
- Alarm Management.
global
- Global objects that are applicable Node wide.
oam
profiles
- Profiles of configuration shared by multiple objects.
system
show
The show operation is used in the system-level CLI mode for following objects:
"show cli" on page 2 20

"show configuration" on page 2 20
"show notification" on page 2 29
"show status" on page 2 30
"show table" on page 2 133
"show users" on page 2 153
"show utils" on page 2 154
To display the command objects, enter show and then Tab key:
admin@Irving> show
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
NOTE
The parameter displaylevel is available to many of the show

commands to specify the level of detail to display. For simplicity, it will
not always be included in the object descriptions in this chapter.

2 19
CLI Reference Guide

System Commands
show cli
Use this object to view the history of system-level CLI commands entered for the
current session.
Command Syntax
> show cli history
> show cli history <# of command entries to display>
CLI History Parameters

TABLE 2 14 CLI History Parameters
Parameter
Length/
Range
Description
cli history
N/A
History of CLI commands previously entered. (Default = 100)
<nonNegativeInteger>
1-32000
Optionally enter a number to specify the number of CLI

command entries 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 current SBC 5x00 configuration
details using the following objects:
"addressContext" on page 2 20
"details" on page 2 23
"displaylevel" on page 2 23
"global" on page 2 23
"oam" on page 2 24
"profiles" on page 2 25
"system" on page 2 27
addressContext
> show configuration addressContext
diamNode <node>
2 20

CLI Reference Guide

System Commands
ipInterfaceGroupName
ipV4Address
ipV6Address
originRealm
peer
primaryOriginHost
realmRoute
secondaryOriginHost
state
transactionTimeout
dnsGroup
interface mgmtGroup
localRecord
data
ipAddress <ip address>
priority <0-100>
state <disabled|enabled>
type <a>
hostName <name>
order <priority|roundrobin>
server
priority <0-100>
recursionDesired <false|true>
weight <0-100>
type <ip|mgmt|none>
ipAccessControlList
rule
ipInterfaceGroup
ipInterface
action
altIpAddress
altPrefix
bandwidth
bwContingency
ceName

2 21
CLI Reference Guide

System Commands
dryupTimeout
ipAddress
mode
portName
prefix
state
vlanTag
ipsec <disabled|enabled>
ipsec
peer
ipAddress
localIdentity
preSharedKey
protectionProfile
protocol
remoteIdentity
spd
action
localIpaddr
localIpPrefixLen
localPort
peer
precedence
protectionProfile
protocol
remoteIpAddr
remoteIpPrefixLen
remotePort
state
linkDetectionGroup
ceName
linkMonitor
reattemptTimer
responseTimer
retries
state
threshold
type
2 22

CLI Reference Guide

System Commands
verifyTimer
natDirectMediaGroup
dmNatPrefix
rtpServerTable
staticRoute preference
zone
details
> show configuration details
displaylevel
Use this option to specify how many levels of detail to display.
> show configuration displaylevel <1-64>
global
> show configuration global
cac
sharedCacLimitsPool
callRouting
route
routingLabel
callTrace
callFilter
errorFilter
maxTriggerCount
signalingPacketCapture
carrier <carrier id>
services
country <country id>
listOfNumberOfDigitsToMatch
variableLengthDialPlan
license
sessionThreshold
monitorEndpoint
mct
monitorTarget

2 23
CLI Reference Guide

System Commands
npaNxx <#>
portedFlag
qoeCallRouting
mediaQosBasedRouting
signalingQosBasedRouting
script
description
majorVersion
minorVersion
security
ipsec
servers
dns
e911
e911VpcDevice
enumDomain
enumService
signaling
gwSigTimers
h323SigTimers
sipPeerOverloadControl
sipSigControls
sipDomain
subscriber <packetServiceProfile|services>
oam
> show configuration oam
accounting
admin
cdrServer
radius
alarms
ipPolicingAlarmAdmin
eventLog
filterAdmin
subsystemAdmin
typeAdmin
localAuth
2 24

CLI Reference Guide

System Commands
user
radiusAuthentication
radiusNasIp
radiusServerIp
radiusServerPort
radiusSharedSecret
snmp
trapTarget
traps
admin
dspAdmin
profiles
> show configuration profiles
callParameterFilterProfile
callRouting
crankbackProfile
elementRoutingPriority
holiday
timeRangeProfile
digitParameterHandling
dmPmCriteria
dmPmRule
numberTranslationCriteria
numberingPlan
prefixProfile
digitProfile
dtmfTrigger
interdigitTimeout
longdigitDuration
pattern
state
featureControlProfile <profile name>
processDestinationTgrp
processDestinationTrunkContext
ipSignalingPeerGroup
media
announcementPackage
2 25
CLI Reference Guide

System Commands
codecEntry
mediaQosKpiProfile
packetServiceProfile
toneAndAnnouncementProfile
tonePackage
toneProfile
security
cryptoSuiteProfile
ikeProtectionProfile
ipsecProtectionProfile
tlsProfile
services
classOfService
dblProfile
disconnectSignalSequenceProfile
disconnectTreatmentProfile
displaylevel
emergencyCallProfile
pathCheckProfile
sipArsProfile
sipSecurityProfile
signaling
XHeaderProfile
displaylevel
ipSignalingProfile
isupSignalingProfile
numberGlobalizationProfile
sctpProfile
signalingProfile
signalingQosKpiProfile
sipAdaptorProfile
sipCauseCodeMapping
sipCacProfile
aggregateMessage
bandwidthLimit
bandwidthLimitThreshold
callEgressAggregateEmergencyPreference
callEgressAggregatePreference
2 26

CLI Reference Guide

System Commands
callEgressBurstSize
callEgressEmergencyPreference
callEgressRate
callEgressRatePeriod
callIngressAggregateEmergencyPreference
callIngressAggregatePreference
callIngressBurstSize
callIngressEmergencyPreference
callIngressRate
callIngressRatePeriod
callLimit
callLimitEgress
callLimitIngress
callLimitThreshold
dblAggregateRej
emergencyOversubscription
emergencyOversubscriptionEgress
emergencyOversubscriptionIngress
message
notify
options
otherRequests
qoe
refer
response
state
subscribe
system
coredumpProfile
ipPolicingAlarmProfile
overloadProfile
system
> show configuration system
admin
auditLogState
cliIdleTimeout
cliSetWarningSupport
2 27
CLI Reference Guide

System Commands
contact
externalAuthenticationEnabled
localAuthenticationEnabled
location
managementIpVersion
passwordRules
standbyServerState
utilMonitorStatsInterval
utilMonitorStatsNumOfPastInterval
congestion
adaptive
levelMC1
levelMC2
levelMC3
mode
policer
dspPad
audioTxDuring2833
comfortEnergy
displaylevel
jitterEvalPeriod
jitterMinOccThsh
playoutTimeseriesPeriod
playoutTimeseriesThreshold0
rtpDtmfRelay
sidHangoverTime
sidMaxNoiseFloor
sidMaxTime
sidMinNoiseFloor
sidMinTime
toneThreshold
toneThresholdState
universalCompressionThreshold
universalCompressionThresholdState
ethernetPort
mgmtAdmin
2 28

CLI Reference Guide

System Commands
packetAdmin
intervalStatistics
numOfPastIntervals
timeInterval
jsrcServer
globalConfig
remoteServer
logicalMgmtIpInterface
media
mediaPeerInactivity
mediaPortRange
mediaRtcpControl
mediaProfile
compression
tone
mgmtIpInterfaceGroup
mgmtGroup
mgmtStaticRoute <dest. ip address>
preference <1-99>
ntp
serverAdmin
timeZone
policyServer
globalConfig
localServer
remoteServer
security
ipsec
pki
serverAdmin
coreDumpProfile
role
show notification
The show notification command displays current SBC 5x00 system
notifications.

2 29
CLI Reference Guide

System Commands
Command Syntax
To display the current notifications of the SBC 5x00 system:
show notification stream
show status
The show status command displays the current status of the following SBC
5x00 objects at a system level.
"alarms" on page 2 78
"oam" on page 2 101
addressContext
The command syntax of the objects related to the show status
addressContext command is shown below. Note that the <addressContext
name> parameter is optional.
> show status addressContext <addressContext name>
cacOffenderStatus <cac parameter>
dnsGroup <dnsEntry parameter>
dynamicBlackList <dbl parameters>
ipAccessControlList <ACL stats parameter>
ipInterfaceGroup <IG name>
ipRouteStatus
ipsec
linkDetectionGroup
linkDetectionGroupStatistics
linkDetectionGroupStatus
logicalSigAddressBindingStatus
sipActiveGroupRegStatus
sipActiveGroupRegSummaryStatus
sipActiveRegisterNameStatus
sipDeletedRegStatus
sipDeletedRegisterNameStatus
sipRegCountStatistics
sipSubCountStatistics
sipSubscriptionStatus
surrRegCountStatistics
zone
zoneCurrentStatistics
zoneIntervalStatistics
zoneStatus
Command syntax for the above objects is defined in greater detail below:
2 30

CLI Reference Guide

System Commands
> show status addressContext cacOffenderStatus

egressCallRejects
firstRejectAt
ingressCallRejects
ipAddress
lastRejectAt
zoneId
> show status addressContext dnsGroup <dnsGroup>
dnsEntryDataStatus
dnsEntryStatus
dnsServerStatistics
> show status addressContext dynamicBlackList
dblPolicerStatus
cumulativeEnforcements <#>
policerEnforcements <#>
dblStatus
currentAction <blacklist|watch>
discardPacketCount <#>
effectivePeriodRemaining <60-86400>
trunkGroup <TG_NAME>
>
show status addressContext intercept

interceptCallDataChannelStatistics
> show status addressContext ipAccessControlList

defaultAclStatistics
ipAclOverallStatistics
ipAclRuleStatistics
ipAclRulesByPrecedence
> show status addressContext ipInterfaceGroup <IG name>
ipInterfaceStatus
> show status addressContext ipRouteStatus <system name> <ip
address> <prefix> protocol <bbnSpfIgp|bgp|ciscoEigrp|
ciscoIgrp|egp|esIs|ggp|hello|icmp|idpr|isIs|local|
netmgmt|ospf|other|rip>
>
show status addressContext ipsec

ikeSaStatistics
ikeSaStatus
ipsecSaStatistics
ipsecSaStatus
> show status addressContext linkDetectionGroup

linkDetectionGroup
> show status addressContext linkDetectionGroupStatistics
<ldgs name>
doubleFailures
failures
singleFailures
2 31
CLI Reference Guide

System Commands
> show status addressContext linkDetectionGroupStatus <ldgs

name> failures
> show status addressContext logicalSigAddressBindingStatus
<ip interface>
> show status addressContext sipActiveGroupRegStatus <id>
aorName|contactURI|creationTime|extExpirationTime|
intExpirationTime|nextHopIpAddress|nextHopPortNum|
regIdIsChild|registrarDomainName|registrarIpAddress|
registrarPortNum|state
> show status addressContext sipActiveGroupRegSummaryStatus
<registrar ip address>
aorName
nextRegIdIsChild
state
> show status addressContext sipActiveRegisterNameStatus
<aor name>
contactURI|creationTime|endPointBehindNapt|
externalExpirationTime|internalExpirationTime|
natPinholeLearningStatus| nextHopIpAddress|
nextHopPortNum|registrarDomainName|registrarIpAddress|
registrarPortNum|securityMechanismType|state
> show status addressContext sipDeletedRegStatus <id>
aorName|contactURI|creationTime|nextHopIpAddress|
nextHopPortNum|reasonCode|registrarDomainName|
registrarIpAddress|registrarPortNum|terminationTime
> show status addressContext sipDeletedRegisterNameStatus
<aor name>
contactURI|creationTime|nextHopIpAddress|
nextHopPortNum|reasonCode|registrarDomainName|
registrarIpAddress|registrarPortNum|terminationTime
> show status addressContext sipRegCountStatistics entry
sipRegCountAttempts
sipRegCountCumCompletions
sipRegCountPending
sipRegCountStable
sipRegCountTotal
> show status addressContext sipSubCountStatistics entry
sipSubCountAttempts
sipSubCountCumCompletions
sipSubCountPending
sipSubCountStable
sipSubCountTotal
> show status addressContext sipSubscriptionStatus <id>
callId|expirationTime|nextHopIpAddress|nextHopPortNum|
origEPDomain|previousHopIpAddress|previousHopPortNum|
serverDomainName|state
> show status addressContext surrRegCountStatistics entry
surrRegActiveRegCount
surrRegConfiguredCount
2 32

CLI Reference Guide

System Commands
> show status addressContext zone <zone name>

callCurrentStatistics
callFailureCurrentStatistics
callFailureIntervalStatistics
callIntervalStatistics
gwSigPortStatistics
gwSigPortStatus
h323SigPortStatistics
h323SigPortStatus
peerPathchkStatus
peerQosStatus
peerSurrRegStatus
sipArsStatus
sipCurrentStatistics
sipIntervalStatistics
sipOcsCallCurrentStatistics
sipOcsCallIntervalStatistics
sipPeerCacStatus
sipRegAdaptiveNaptLearningStatistics
sipSigConnStatistics
sipSigConnStatus
sipSigPortStatistics
sipSigPortStatus
sipSigPortTlsStatistics
sipSigTlsSessionStatus
sonusSipSigPeerOvldStatusEntry
trafficControlCurrentStatistic
trafficControlIntervalStatistics
trunkGroupQoeStatus
trunkGroupStatus
> show status addressContext zoneCurrentStatistics <zone
name>
egressFailBWLimit|egressFailCallLimit|
egressFailCallPolicing|egressSipRegFailLimit|
egressSipRegPolicing|ingressFailBWLimit|
ingressFailCallLimit|ingressFailCallPolicing|
ingressSipRegFailLimit|ingressSipRegPolicing
> show status addressContext zoneIntervalStatistics
<counter*>
egressFailBWLimit|egressFailCallLimit|
egressFailCallPolicing|egressSipRegFailLimit|egressSipReg
Policing|ingressFailBWLimit|ingressFailCallLimit|
ingressFailCallPolicing|ingressSipRegFailLimit|
ingressSipRegPolicing|intervalValid|time
* The counter is associated with a performance measurement in a previous 15-minute
measurement interval. In the case where the agent has no valid data available for a
particular interval, the corresponding object instance is not available; and upon a
retrieval request a corresponding error message is returned to indicate that this
instance does not exist (for example, a noSuchName error for SNMPv1 and a
noSuchInstance for SNMPv2 GET operation).

2 33
CLI Reference Guide

System Commands
In a system supporting a history of n intervals with IntervalCount(1) and

IntervalCount(n) the most and least recent intervals respectively, the following applies
at the end of a 15-minute interval:
discard the value of IntervalCount(n)

the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1
the value of IntervalCount(1) becomes that of CurrentCount
the TotalCount, if supported, is adjusted.
> show status addressContext zoneStatus <zone name>

activeSipRegCount|bwAvailable|bwCurrentLimit|
bwInboundUsage|bwOutboundUsage|emergencyCallsBwUsage|
inboundCallsUsage|outboundCallsUsage|priorityCallUsage|
totalCallsAvailable
TABLE 2 15 show status addressContext Parameters
Parameter
Length/
Range Description
addressContext
1-23

Addressing domain. Must be 1-23 characters.
cacOffenderStatus
N/A
Displays recent SIP endpoint CAC offenders.

Enter index number when prompted, plus optional parameter:
dnsGroup
1-23
egressCallRejects <integer>
firstRejectAt <date & time>
ingressCallRejects <integer>
lastRejectAt <date & time>
zoneId <integer>
Name of this DNS Group Entry. Must be 1-23 characters. The

possible options are:
dnsEntryDataStatus DNS entry data status.
dnsEntryStatus DNS entry record status.
dnsServerStatistics DNS server statistics for this
address context.
2 34

CLI Reference Guide

System Commands
TABLE 2 15 show status addressContext Parameters (Continued)

Parameter
Length/
Range Description
dynamicBlackList
N/A
Collection of Dynamic Black List (DBL) policers. Options are:

dblPolicerStatus Collection of DBL list policer status.
sip <trunkgroup type>
cumulativeEnforcements <#> Cumulative
number of DBL policer enforcements during the
lifetime of the effective profile/rule.
policerEnforcements <#> Current number of
DBL policer enforcements blacklisted on network
processor.
dblStatus Status of configured Dynamic Black List.
currentAction Use this parameter to specify
whether to blacklist or watch the endpoint.
blacklist
watch
discardPacketCount <#> The number of packets
dropped due to NP blacklisting of this endpoint.
effectivePeriodRemaining The period of time (in
seconds) the DBL entry will remain in effect. (range: 6086400)
trunkGroup <TG_NAME> The name of the trunk
group that the packet came in on that triggered this DBL
entry.
intercept
N/A
Use this object to view the following Lawful Intercept Call Data
Channel statistics details:
Arguments include:
CallAnswerFailures The number of unsuccessful
call answer that occurred.
CallAnswerSuccess The number of successful call
answers that occurred.
CallDisconnectFailures The number of
unsuccessful call disconnects that occurred.
CallDisconnectSuccess The number of successful
call disconnects that occurred.
IndicationFailures The number of unsuccessful
indications that occurred.
IndicationSuccess The number of successful
indications that occurred.

2 35
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
intercept (continued)
N/A
ipAccessControlList
N/A
KeepAliveFailures The number of unsuccessful

keep alive messages that occurred.
KeepAliveSuccess The number of successful Keep
Alive messages that occurred.
RadiusAckReceived The number of Radius
acknowledgements received.
RestartFailures The number of unsuccessful
restarts that occurred.
RestartSuccess The number of successful restarts
that occurred.
ServiceInstanceFailures The number of
unsuccessful service instances that occurred.
ServiceInstanceSuccess The number of
successful service instances that occurred.
StartFailures The number of unsuccessful signal
starts that occurred.
StartResponsesReceived The number of signal
start responses received.
StartSuccess The number of successful signal starts
that occurred.
StopFailures The number of unsuccessful signal
stops that occurred.
StopSuccess The number of successful signal stops
that occurred.
primaryChannelStatus Primary channel status.
inService
outOfService
secondaryChannelStatus The secondary channel
status.
inService
outOfService
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 Number of times no rule matched.
displaylevel Sets number of levels to display.
ipAclRuleStatistics IP ACL rule statistics.
matches Number of times this rule matched.
policerDiscards The number of times the policer
for this rule discarded packets.
2 36

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
ipAccessControlList
(continued)
N/A
ipAclRulesByPrecedence IP ACL rules by

precedence.
ipInterfaceGroup
N/A
The name of an IP interface group. Enter IP interface group

name or any to match any IP interface group.
ipInterfaceStatus <interface name> Status of
the IP interface named in this IP interface group.
actualBandwidth Actual bandwidth in use on this IP
interface.
allocatedBandwidth Bandwidth allocated on this IP
interface.
bwDeviation Amount of deviation from actual
bandwidth.
ifindex Index of the LIF.
numCalls Number of active call legs on IP interface.
oosReason Out-of-service reason.
admin
linkDown
notApplicable
portDown
serverDown
standby
operState The operational state.
admnDisabled
admnEnabled
deallocDryup
deallocForce1
deallocForce2
null
remoteCreated
remoteCreating
resAllocated
resAllocating
rxPackets Number of packets received on IP
interface.
txPackets Number of packets sent on IP interface.
ipRouteStatus
N/A
The name which identifies the local interface through which

the next hop of this route must be reached. Options are:
protocol The routing mechanism through which this
route was learned.
bbnSpfIgp|bgp|ciscoEigrp|ciscoIgrp|egp|
esIs|ggp|hello|icmp|idpr|isIs|local|
netmgmt|ospf|other|rip

2 37
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
ipsec
N/A
IP security configuration, such as security policy database and

IKE SA information. For details of the ipsec sub-parameters,
see Table 2 16 on page 2 47).
ikeSaStatistics <sai> IKE SA statistics.
ipsecSaNegotiationsFailed|ipsecSaNegotiati
onsSucceeded|localIpAddr|peerIpAddr
ikeSaStatus <sai> IKE SA status.
encType|integrityType|localId|localIpAddr|
peerId|peerIpAddr|secondsRemaining
ipsecSaStatistics <spi> IPSEC SA statistics.
inBytesCount|inPacketDiscardAntiReplay|
inPacketDiscardFailedIntegrity|
inPacketsCount|localIpAddr|outBytesCount|
outPacketsCount|peerIpAddr|remoteSpi
ipsecSaStatus <local spi> IPSEC SA status.
bytesRemaining|encType|ikeSaIndex|
integrityType|localSelector|
localTerminationAddr|remoteSPI|
remoteSelector|remoteTerminationAddr|
secondsRemaining|selectorName|
upperLayerProtocol
systemStatistics <sys name> IPSEC system
statistics.
ikeSaNegotiationsFailed
ikeSaNegotiationsSucceeded
inPacketDiscardDiscarded
inPacketDiscardInvalidSpi
inPacketDiscardNoState
inPacketDiscardProtected
inPacketDiscardSAExpired
inPacketDiscardSelectorMismatch
ipsecSaNegotiationsFailed
ipsecSaNegotiationsSucceeded
outPacketDiscardDiscarded
outPacketDiscardProtected
outPacketDiscardSAExpired
outPacketDiscardSSNWrap
sai = security association index
spi = security parameter index
2 38

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
linkDetectionGroup
N/A
The link detection group in this address context. Additional

parameters and arguments include:
<ltg name>
linkMonitorStatistics <lm name>
averageTime Average time (in microseconds) used to
get a reply for an echo request packet.
doubleFailures Number of double failures for this
IP interface.
duplicateReplies Number of duplicate replies.
failures Number of failures for this IP interface.
lateReplies Number of late replies.
maxTime Maximum time (in microseconds) used to get
a reply for an echo request packet.
minTime Minimum time (in microseconds) used to get
a reply for an echo request packet.
replies Total number of replies.
singleFailures Number of single failures for this IP
interface.
linkMonitorStatus <lm name>
linkStatus
monitorStatus
linkDetectionGroupStatis N/A
tics
Link failure statistics per trunk group.

<ltg name>
doubleFailures <int> Number of times a link
monitor within this link detection group failed to receive two
consecutive echo replies. The second reattempt was
successful.
failures <int> Number of times a link monitor within
this link detection group declared itself failed.
singleFailures <int> Number of times a link
monitor within this link detection group failed to receive a
single echo reply. The first reattempt was successful.
int = integer
linkDetectionGroupStatus N/A
Link detection group status.

<ltg name>
failures <int> Number of times a link monitor within
this link detection group declared itself failed.
int = integer
logicalSigAddressBinding N/A
Status
Status of logical signaling address bindings.

<ip interface>
<ip address>

2 39
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
Active SIP group registration status for a list of SIP endpoints.

aorName <string> The E.164 number and host portion
plus optional BGID representing the Address Of Record of
the registering endpoint (max length: 127 characters).
contactURI <string> The SIP CONTACT URI header
(max length: 127 characters).
creationTime Octet string that identifies the date and
GMT time at which the SIP registration is initiated.
extExpirationTime The external expiration timer
value in seconds.
intExpirationTime The internal expiration timer value
in seconds.
nextHopIpAddress Next hop TSAP IP address.
nextHopPortNum Next hop TSAP UDP port number.
regIdIsChild <regId#> Optionally display results
where the specified next registration ID is a child.
registrarDomainName SIP registrar's domain name.
registrarIpAddress SIP Registrar's IP Address.
registrarPortNum SIP Registrar's UDP port number.
state The registration state of the endpoint.
challenged
completed
deleting
expired
initiating
null
refreshing
terminated
updating
2 40

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
sipActiveGroupRegSummary N/A
Status
The active SIP group registration summary for a list of SIP

endpoints. Parameters include:
aorName <string> The E.164 number and host portion
plus optional BGID representing the Address Of Record of
the registering endpoint (max length: 127 characters).
nextRegIdIsChild <regId#> Optionally display
results where the specified next registration ID is a child.
state The registration state of the endpoint.
challenged
completed
deleting
expired
initiating
null
refreshing
terminated
updating
sipActiveRegisterNameSta N/A
tus
The active SIP registration name status for a list of SIP

endpoints.
contactURI <string> SIP CONTACT URI header.
creationTime <dateTime> Octet string identifying
date and GMT time at which the SIP registration is initiated.
endPointBehindNapt Set to 1 if the registered
endpoint is behind NAPT; otherwise, enter 0.
externalExpirationTime <#> The external
expiration timer value in seconds.
internalExpirationTime <#> The internal
expiration timer value in seconds.
natPinholeLearningStatus Use this parameter to
select the pinhole learning process state to filter by:
aborted-due-to-traffic
completed
completed-due-to-timeout
disabled
none
progressing
nextHopIpAddress <ip address> Next hop
Transport Service Access Point (TSAP) IP address.
nextHopPortNum <#> Next hop TSAP UDP port
number.
registrarDomainName <string> The SIP registrar's
domain name.

2 41
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
sipActiveRegisterNameSta N/A
tus (continued)
registrarIpAddress <ip address> SIP Registrar's

IP Address.
registrarPortNum <#> SIP Registrar's UDP port
number.
securityMechanismType Use to identify the security
mechanism type used for this registration.
ipsec-3gpp
none
tls
state The registration state of the endpoint:
challenged|completed|deleting|initiating|n
ull|refreshing|terminated|updating
N/A
The deleted SIP registration status for a list of SIP endpoints.
sipDeletedRegStatus
aorName The E.164 number and host portion plus

optional BGID representing the address Of Record of the
registering endpoint.
contactURI The SIP CONTACT URI header.
creationTime Octet string that identifies the date and
GMT time at which the SIP registration is initiated.
nextHopIpAddress <ip address> Next hop
Transport Service Access Point (TSAP) IP address.
nextHopPortNum <#> Next hop TSAP UDP port
number.
reasonCode Registration termination reason. Options:
configProblem|endpointInitiated|
internalError|none|regTimerExpired|
registrationMoved|registrationRejected|
serviceUnavailable
registrarDomainName <string> The SIP registrar's
domain name.
registrarIpAddress <ip address> SIP Registrar's
IP Address.
registrarPortNum <#> SIP Registrar's UDP port
number.
terminationTime <dateTime> Date and GMT time
at which the SIP registration is terminated.
sipDeletedRegisterNameSt N/A
atus
2 42
The deleted SIP registered name status for a list of SIP

endpoints.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
Use this object to display the SIP registration count statistics

for the SIP endpoints or node.
entry Name of the system.
Use the following optional parameters to filter results:
sipRegCountAttempts <#> Number of SIP
registration attempts on SBC 5x00.
sipRegCountCumCompletions <#> Accumulative
number of completed SIP registration attempts.
sipRegCountPending <#> Current number of pending
SIP registrations.
sipRegCountStable <#> Current number of stable
SIP registrations.
sipRegCountTotal <#> The total number of current
SIP registrations.
N/A
Use this object to display the SIP relayed subscription count

statistics for the SIP endpoints or node.
Use the following optional parameters to filter results:
sipSubCountAttempts <#> Number of SIP relayed
subscription attempts.
sipSubCountCumCompletions <#> Accumulative
number of completed SIP subscription attempts.
sipSubCountStable <#> Current number of stable SIP
subscriptions.
sipSubCountTotal <#> Total number of current SIP
subscriptions (sipSubCountAttempts +
sipSubCountCumCompletions).
NOTE: At present, the parameter sipSubCountTotal is not
supported and will return 0.

2 43
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
The active SIP subscription status for a list of SIP endpoints.

callId Caller ID that uniquely identified the relayed
subscription. (max. 63 characters).
expirationTime The expiration timer value in seconds.
nextHopIpAddress Next hop TSAP IP address.
nextHopPortNum Next hop TSAP UDP port number.
origEPDomain Originating endpoint contact host. (max.
127 characters).
previousHopIpAddress Originating endpoint's IP
Address.
previousHopPortNum Originating endpoint's UDP port
number.
serverDomainName The SIP subscription server's
domain name. (max. 127 characters).
state The subscription state of the endpoint.
active
expired
initiating
null
terminated
N/A
Surrogate registration count statistics for the node.

surrRegActiveRegCount The number of IP Peers for
which surrogate registration is enabled and presently
active.
surrRegConfiguredCount The number of IP Peers for
which surrogate registration is enabled. For example, if the
surrogateRegistration flag is enabled for three out of five
peers, the surrRegConfiguredCount is 3.
2 44

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
zone
1-23
Use this object to view zone statistics for <zone name> zone.
Zone parameters include following (see Table 2 17 on
page 2 50 for further parameter details):
N/A
gwSigPortStatistics
gwSigPortStatus
h323SigPortStatus
peerPathchkStatus
peerSurrRegStatus
sipArsStatus
sipPeerCacStatus
sipSigConnStatus
sipSigPortStatus
trafficControlCurrentStatistics
trunkGroupQoeStatus
trunkGroupStatus
The Zone Statistics Current table entries.

egressFailBWLimit Number of outgoing failed calls
due to bandwidth limit.
egressFailCallLimit Number of outgoing failed calls
due to call limit.
egressFailCallPolicing Number of outgoing failed
calls due to call rate.
egressSipRegFailLimit Number of outgoing SIP
Registrations failed due to registration limit.

2 45
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
(continued)
N/A
egressSipRegPolicing Number of outgoing SIP

Registrations failed due to registration rate.
ingressFailBWLimit Number of incoming failed calls
ingressFailCallLimit Number of incoming failed
calls due to call limit.
ingressFailCallPolicing Number of incoming
failed calls due to call rate.
ingressSipRegFailLimit Number of incoming SIP
Registrations failed due to registrations limit.
ingressSipRegPolicing Number of incoming SIP
N/A
The Zone Statistics Interval table entries.

egressFailBWLimit Number of outgoing failed calls
egressFailCallLimit Number of outgoing failed calls
due to call limit.
egressFailCallPolicing Number of outgoing failed
calls due to call rate.
egressSipRegFailLimit Number of outgoing SIP
egressSipRegPolicing Number of outgoing SIP
ingressFailBWLimit Number of incoming failed calls
ingressFailCallLimit Number of incoming failed
calls due to call limit.
ingressFailCallPolicing Number of incoming
failed calls due to call rate.
ingressSipRegFailLimit Number of incoming SIP
ingressSipRegPolicing Number of incoming SIP
intervalValid Use to indicate valid interval. Options:
true
false
time System up time when the interval statistics is
collected.
2 46

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
zoneStatus
N/A
Current status for zones in this address context. Options are:

activeSipRegCount Number of SIP registrations active
across all IP trunks in this zone.
bandwidthAvailable Available media bandwidth
bandwidthCurrentLimit Current media bandwidth
limit across all IP trunks in this zone.
bwInboundUsage Current media bandwidth in use for
inbound traffic across all IP trunks in this zone.
bwOutboundUsage Current media bandwidth in use for
outbound traffic across all IP trunks in this zone.
callsAvailableTotal Sum of all available or
unblocked calls across all IP trunks in this zone.
callsConfiguredTotal Total number of calls
configured (allowed) across all IP trunks in this zone.
emergencyCallsBwUsage Current media bandwidth in
use for emergency calls across all IP trunks in this zone.
inboundCallsUsage Current inbound usage count
outboundCallsUsage Current outbound, non-priority
usage count across all IP trunks in this zone.
priorityCallUsage Current priority call count across
all IP trunks in this zone.
TABLE 2 16 show status addressContext ipsec Parameters

Parameter
Length/
Range Description
ikeSaStatistics <sai>
N/A
IKE SA statistics. The sai options are:
ipsecSaNegotiationsFailed
ipsecSaNegotiationsSucceeded
localIpAddr
peerIpAddr

2 47
CLI Reference Guide

System Commands
TABLE 2 16 show status addressContext ipsec Parameters (Continued)

Parameter
Length/
Range Description
ikeSaStatus <sai>
N/A
IKE SA status. The sai options are:
encType
integrityType
localId
localIpAddr
peerId
peerIpAddr
secondsRemaining

ipsecSaStatistics <spi>
N/A
IPSEC SA statistics. The spi options are:
inBytesCount
inPacketDiscardAntiReplay
inPacketDiscardFailedIntegrity
inPacketsCount
localIpAddr
outBytesCount
outPacketsCount
peerIpAddr
remoteSpi

ipsecSaStatus <local spi>
IPSEC SA status. The spi options are:
bytesRemaining
encType|ikeSaIndex
integrityType
localSelector
localTerminationAddr
remoteSPI
remoteSelector
remoteTerminationAddr
secondsRemaining
selectorName|
upperLayerProtocol
2 48

CLI Reference Guide

System Commands
TABLE 2 16 show status addressContext ipsec Parameters (Continued)

Parameter
systemStatistics <sys
name>
Length/
Range Description
N/A
IPSEC system statistics.

ikeSaNegotiationsFailed Number of phase-1
(Main Mode) Security Association negotiation failures.
ikeSaNegotiationsSucceeded Number of phase1 (Main mode) Security Association negotiations
resulting in a phase-1 SA being established.
inPacketDiscardDiscarded Number of incoming
ISAKMP packets discarded as a result of matching a
discard SPD rule.
inPacketDiscardInvalidSpi Incoming ESP
packets discarded due to their SPI not matching an
existing phase-2 SA.
inPacketDiscardNoState Number of incoming
discard no state rule.
inPacketDiscardProtected Number of incoming
protect SPD rule.
inPacketDiscardSAExpired Number of incoming
ESP packets discarded since they arrived on a phase-2
SA that has expired.
inPacketDiscardSelectorMismatch Number of
Incoming ESP packets discarded due to selector
mismatch.
ipsecSaNegotiationsFailed Number of phase-2
(Quick Mode) Security Association negotiation failures.
ipsecSaNegotiationsSucceeded Number of
successful phase-2 (Quick Mode) Security Association
negotiations.
outPacketDiscardDiscarded Number of outgoing
discard SPD rule.
outPacketDiscardProtected Number of outgoing
protect SPD rule.
outPacketDiscardSAExpired Number of outgoing
ESP packets discarded since they are for a phase-2 SA
that has expired.
outPacketDiscardSSNWrap Number of outgoing
ESP packets discarded due to wrapping around of the
sequence number.

2 49
CLI Reference Guide

System Commands
TABLE 2 17 show status addressContext zone Parameters

Parameter
Length/
Range Description
N/A
Current call statistics for a trunk group. Additional

parameters:
2 50
<tg name> Enter trunk group name.

activeRegs Number of active registrations.
activeSubs Number of active subscriptions.
callSetupTime Total call setup time for all completed
calls in the inbound and outbound directions measured in
hundredths of a second.
callSetups Total number of calls setup but not
necessarily completed in inbound and outbound
directions.
callsWithPktOutage Number of calls with a
maximum packet outage whose duration exceeds the
configured minimum.
callsWithPktOutageAtEnd Number of calls whose
maximum packet outage occurs at the end of the call.
callsWithPsxDips Number of calls that made a ERE
Dip.
inBwUsage Sum of bandwidth usage (expected data
rate in Kbits per second multiplied by call duration in
seconds) for every inbound call associated with this TG.
inCallAttempts Current number of inbound call
attempts.
inCalls Current number of completed inbound calls.
inUsage Current usage in the inbound direction (in
seconds).
maxActiveBwUsage Maximum bandwidth usage in
either direction associated with this trunk group.
maxActiveCalls 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.
maxActiveRegs Maximum number of active
registrations (high watermark achieved on trunk group).
maxActiveSubs Maximum number of active
subscriptions.
maxPktOutage Single longest maximum reported
packet outage duration (in milliseconds) experienced
during the current performance interval for this TG.
outBwUsage Sum of bandwidth usage for every
outbound call associated with this trunk group (expected
data rate in Kbps multiplied by call duration in seconds).

CLI Reference Guide

System Commands
TABLE 2 17 show status addressContext zone Parameters (Continued)

Parameter
(continued)
Length/
Range Description
N/A
outCallAttempts Number of outbound call attempts

on this trunk group.
outCalls Number of completed outbound calls on this
trunk group.
outUsage Current usage in the outbound direction for
this trunk group in seconds.
playoutBufferAcceptable Number of calls with all
sub-intervals reporting ACCEPTABLE or better playout
buffer quality.
playoutBufferGood Number of calls with all subintervals reporting GOOD playout buffer quality.
playoutBufferPoor Number of calls with all subintervals reporting POOR or better playout buffer quality
for this trunk group.
playoutBufferUnacceptable Number of calls with
at least one sub-interval reporting UNACCEPTABLE
playout buffer quality.
podEvents Number of Packet Outage Detection (POD)
Events detected.
routingAttempts Number of routing attempts.
sipRegAttempts Number of SIP registration attempts
on a trunk group.
sipRegCompletions Number of SIP registrations
completed on a trunk group.
totalPktOutage Summation of all packet outage
durations (in milliseconds) which exceed the configured
minimum that is experienced during the current
performance interval for this trunk group.
totalPsxDips Current number of Psx Dips made.

2 51
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
callFailureCurrentStatis N/A
tics
2 52
Trunk group current call failure statistics.

allocFailBwLimit Number of bandwidth requests
failing due to configured TG bandwidth limit exceeded.
allocFailCallLimit Number of bandwidth requests
which fail because configured TG call limit is exceeded.
allocFailParentConstraint Current number of
failures caused by parent limit denial.
callAbandoned Current number of calls on a trunk
group abandoned while dialing.
callFailPolicing Current number of calls on a
trunk group that failed due to policing.
inCallFailInvalidCall Current number of inbound
failed calls because there was an invalid call attempt for
this trunk group.
inCallFailNetworkFailure Current number of
inbound failed calls because there was a network failure
inCallFailNoResources Current number of inbound
failed calls because there was an unavailable resource for
this trunk group.
inCallFailNoRoutes Current number of inbound
failed calls because there was no route available for this
trunk group.
inCallFailNoService Current number of inbound
failed calls because there was an unavailable service for
this trunk group.
inCallFailProtocolError Current number of
inbound failed calls because there was a protocol error for
this trunk group.
inCallFailUnspecified Current number of inbound
failed calls for an unspecified reason for this trunk group.
invalidSPCallsFailed Current number of calls that
failed due to mismatched ingress signaling port from CP
according to RCB.
noPsxRoute Current number of calls on an ingress
trunk group that failed due to no routes.
nonMatchSrcIpCallsFail Number of calls that
failed due to mismatched source IP of IAD according to its
RCB for the specified interval.
outCallFailInvalidCall Number of outbound
failed calls due to invalid call attempt for this trunk group
for the specified interval.
outCallFailNetworkFailure Number of outbound
failed calls due to network failure for this trunk group for
the specified interval.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
callFailureCurrentStatis N/A
tics (continued)
outCallFailNoResources Number of outbound

failed calls due to unavailable resource for this trunk
group for the specified interval.
outCallFailNoRoutes Number of outbound failed
calls due to no route available for this trunk group for the
specified interval.
outCallFailNoService Number of outbound failed
calls due to unavailable service for this trunk group for the
specified interval.
outCallFailProtocolError Number of outbound
failed calls due to protocol error for this trunk group for the
specified interval.
outCallFailUnspecified Number of outbound
failed calls for an unspecified reason for this trunk group
regCallsFailed Current number of calls that failed
due to registration requirement for SIP trunk group.
routingFailuresResv Number of routing failures
due to all circuits reserved for this trunk group for
specified interval.
securityFail Number of calls that failed due to
mismatch between the peer security and route packet
service profile security on trunk group for specified
interval.
sipOtherReqFailPolicing Current number of SIP
other non-invite attempts that failed due to policing on
trunk group.
sipRegFailInternal Number SIP registration
attempts that failed due to other reasons (signaling
failures, and so on) 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 Number SIP registration
attempts that failed due to policing on TG for specified
interval.
sipSubsFailPolicing Current number of SIP
Subscribe attempts that failed due to policing on a trunk
group.

2 53
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
callFailureIntervalStati N/A
stics
Call failure interval statistics for this trunk group. Additional

parameters include:
<interval> The interval for which the set of statistics
is required.Choices: 751, 752, 753, 754.
allocFailBwLimit Number of bandwidth Requests
which fail because the configured bandwidth limit has
been exceeded for this trunk group for the specified
interval.
allocFailCallLimit Number of bandwidth
Requests which fail because configured call limit has
been exceeded for this trunk group for the specified
interval.
allocFailParentConstraint Number of failures
due to parent limit denial.
callAbandoned Number of calls on a toll-free TG that
were abandoned while dialing for the specified interval.
callFailPolicing Number of calls on a trunk group
that failed due to policing for the specified interval.
inCallFailInvalidCall Number of inbound failed
calls because there was an invalid call attempt for this
trunk group for the specified interval.
inCallFailNetworkFailure Number of inbound
failed calls because there was a network failure for this
inCallFailNoResources Number of inbound failed
calls because there was an unavailable resource for this
inCallFailNoRoutes Number of inbound failed calls
because there was no route available for this trunk group
inCallFailNoService Number of inbound failed
calls because there was an unavailable service for this
inCallFailProtocolError Number of inbound
failed calls because there was a protocol error for this
inCallFailUnspecified Number of inbound failed
calls for an unspecified reason for this trunk group for the
specified interval.
true
false
invalidSPCallsFailed Number of failed calls due
to mismatched ingress signaling port from CP according
to RCB for the specified interval.
2 54

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
stics (continued)
noPsxRoute Number of failed calls on an ingress trunk

group due to no routes returned from the ERE for the
specified interval.
nonMatchSrcIpCallsFail Number of calls that
failed due to mismatched source IP of IAD according to its
RCB for the specified interval.
nonRegCallsFailed Number of failed calls due to
registration requirement for SIP trunk group for the
specified interval.
outCallFailInvalidCall Number of outbound
failed calls due to invalid call attempt for this trunk group
outCallFailNetworkFailure Number of outbound
failed calls due to network failure for this trunk group for
the specified interval.
outCallFailNoResources Number of outbound
failed calls due to unavailable resource for this trunk
outCallFailNoRoutes Number of outbound failed
calls due to no route available for this trunk group for the
specified interval.
outCallFailNoService Number of outbound failed
calls due to unavailable service for this trunk group for the
specified interval.
outCallFailProtocolError Number of outbound
failed calls due to protocol error for this trunk group for the
specified interval.
outCallFailUnspecified Number of outbound
failed calls for an unspecified reason for this trunk group
routingFailuresResv Number of routing failures
due to all circuits reserved for this trunk group for
specified interval.
securityFail Number of calls that failed due to
mismatch between the peer security and route packet
service profile security on trunk group for specified
interval.
sipOtherReqFailPolicing Number of SIP other
non-invite attempts that failed due to policing on trunk
group.
sipRegFailInternal Number SIP registration
attempts that failed due to other reasons (signaling
failures, and so on) on a trunk group for the specified
interval.

2 55
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
stics (continued)
N/A
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 Number SIP registration
attempts that failed due to policing on TG for specified
interval.
sipSubsFailPolicing Number of SIP Subscribe
attempts that failed due to policing on a trunk group.
time System up time when interval statistics is
collected.
Trunk group interval call statistics. Options are:
<interval> Identifies interval for which the set of
statistics is required. Choices: 752, 753, 754, 755.
activeRegs Interval number of active registrations on
this trunk group.
activeSubs Current number of active subscriptions on
this trunk group.
callSetupTime Total call setup time for all completed
calls in inbound and outbound directions for this trunk
group for specified interval measured in hundredths of a
second.
callSetups Total number of calls setup but not
necessarily completed in the inbound and outbound
directions for this trunk group for the specified interval.
callsWithPktOutage Number of calls with a
maximum packet outage whose duration exceeds the
configured minimum for this trunk group for the specified
interval.
callsWithPktOutageAtEnd Number of calls whose
maximum packet outage occurs at the end of the call for
this trunk group for the specified interval.
callsWithPsxDips Number of calls that made a PSX
Dip during the interval.
inBwUsage 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
inCallAttempts Number of inbound call attempts on
inCalls Number of completed inbound calls on this
inUsage 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.
2 56

CLI Reference Guide

System Commands

Parameter
(continued)
Length/
Range Description
N/A
intervalValid Use to indicate valid interval.

true
false
maxActiveBwUsage High water mark bandwidth
usage in either direction associated with this trunk group
maxActiveCalls Current high water mark of total
number of active calls in both inbound and outbound
directions on the trunk group for specified interval. This
statistic is for calls setting up, stable, or tearing down.
maxActiveRegs Maximum active registrations on this
trunk group (high-watermark achieved on this trunk
group).
maxActiveSubs Maximum active subscriptions on this
trunk group (high-watermark achieved on this trunk
group).
during specified performance interval for this trunk group.
during the specified performance interval for this trunk
group.
outBwUsage Sum of bandwidth usage (expected data
rate in bits per second multiplied by call duration in
seconds) for every outbound call associated with this
outCallAttempts Number of outbound call attempts
on this trunk group for the specified interval.
outCalls Number of completed outbound calls on this
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 Number of calls with all
sub-intervals reporting ACCEPTABLE or better playout
buffer quality for this trunk group for the specified interval.
playoutBufferGood Number of calls with all subintervals reporting GOOD playout buffer quality for this
playoutBufferPoor Number of calls with all subintervals reporting POOR or better playout buffer quality
for this trunk group for the specified interval.

2 57
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
(continued)
N/A
playoutBufferUnacceptable Number of calls with

at least one sub-interval reporting UNACCEPTABLE
playout buffer quality for this trunk group for the specified
interval.
podEvents Number of Packet Outage Detection (POD)
Events detected for this peer group for the specified
interval.
routingAttempts Number of routing attempts for this
sipRegAttempts Current number of SIP registration
attempts on a trunk group for the specified interval.
sipRegCompletions Current number of SIP
registrations that have successfully completed on a trunk
collected.
totalPktOutage 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 ERE Dips in the
interval.
gwSigPortStatistics
N/A
Status of the active signaling channels with other gateways.

<ip_address> IP address of remote gateway.
FromBytesReceived The total number of signaling
bytes received from this remote Gateway for incoming
calls.
FromBytesSent The total number of signaling bytes
sent to this remote Gateway for incoming calls.
FromCallRate The number of calls/sec processed by
the GWFE in the last minute on the link which was
originated by the remote.
FromLnkMajorVer The major version of link protocol
being used between gateways.
FromLnkMinorVer The minor version of link protocol
FromPdusReceived The total number of signaling
PDUS received from this remote Gateway for incoming
calls.
2 58

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
gwSigPortStatistics
(continued)
N/A
FromPdusSent The total number of signaling PDUS

sent to this remote Gateway for incoming calls.
FromState Current state of the signaling link from this
remote Gateway.
FromTotalCalls The total number of calls originated
by the remote on this link.
Interface The interface used for this link.
mgtNif
nif
LnkProto The protocol being used between gateways.
NumActiveCalls Number of active calls between local
and remote Gateway.
NumActiveCallsFrom Number of active calls from
this remote Gateway.
NumActiveCallsTo Number of active calls to this
remote Gateway.
RemoteMcLevel The remote gateways machine
congestion level.
ToBytesReceived The total number of signaling bytes
received from this remote Gateway for outgoing calls.
ToBytesSent The total number of signaling bytes sent
to this remote Gateway for outgoing calls.
ToCallRate The number of calls/sec processed by the
GWFE in the last minute on the link which was originated
locally.
ToLnkMajorVer The major version of link protocol
ToLnkMinorVer The minor version of link protocol
ToPdusReceived The total number of signaling PDUS
received from this remote Gateway for outgoing calls.
ToPdusSent The total number of signaling PDUS sent
to this remote Gateway for outgoing calls.
ToState Current state of the signaling link to this
remote Gateway.
ToTotalCalls The total number of calls originated
locally on this link.
gwSigPortStatus
N/A
SIP Signaling port status.

<index> Index of GW signaling port (range: 1-2048).
state Administrative state of SiP signaling port.
inService
outOfService

2 59
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
H.323 Signaling Port Statistics.

activeCalls Number of current active calls.
egressCallsAttempted Number of Egress calls
attempted.
egressCallsCompleted Number of Egress calls
completed.
h225MessageBytesRcvd Number of bytes of H225
messages received.
h225MessageBytesSent Number of bytes of H225
messages sent.
h225MessagesRcvd Number of H225 messages
received.
h225MessagesSent Number of H225 messages sent.
h225TcpPortsOpened Number of H225 TCP ports
currently open.
h245MessageBytesRcvd Number of bytes of H245
messages received.
h245MessageBytesSent Number of bytes of H245
messages sent.
h245MessagesRcvd Number of H245 messages
received.
h245MessagesSent Number of H245 messages sent.
h245TcpPortsAllocated Number of H245 TCP
ports currently allocated.
h245TcpPortsOpened Number of H245 TCP ports
currently open.
ingressCallsAttempted Number of Ingress calls
attempted.
ingressCallsCompleted Number of Ingress calls
completed.
status Status of the H323 Signaling Port.
inService
outOfService
h323SigPortStatus
N/A
H.323 Signaling Port Status.

<port> <#>
state Administrative state of H.323 signaling port.
inService
outOfService
2 60

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
peerPathchkStatus
N/A
Provides ping state, local admin state and remote admin

state for a peer.
<peer_name> Name of peer.
localAdminState Local admin state of the peer.
blocking
down
unblocking
up
pingState Ping state of the peer.
active When pathcheck profile is enabled for a
peer/SIP UA.
down When peer or sip UA does not respond to
Options ping within the configured replyTimeoutCount
value, peer is declared unreachable and state changes
to "down".
inActive When pathcheck profile is disabled for a
peer/SIP UA.
up When SIP UA or Peer is reachable and responds to
Options request with 200 OK.
remoteAdminState Remote admin state of the peer.
down
up
peerQosStatus
N/A
IP PEER QoS KPI status.

currentASR Current ASR value of IP PEER.
currentPGRD Current Post Gateway Routing Delay for
the IP PEER.
egressActiveCalls Number of active calls on IP
PEER.
egressSustainedCallRate Sustained Call Rate of
the IP PEER.
qosDropCount Number of times this IP PEER is
dropped from route list due to KPI Threshold breach.

2 61
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
peerSurrRegStatus
N/A
Provides Surrogate Registration state of IP Peer.

<peer_name> Name of peer.
surrRegState Surrogate Registration state of the
peer.
Active When registration completes successfully.
Deleting When a de-register was sent out and is
awaiting final response from Registrar.
Inactive When surrogate registration or reregistration has failed.
Initiating When register was sent out and is
awaiting response from Registrar. Same state is also
seen when refresh register is sent out or when register
is challenged with 401/407 response and awaiting
response from Registrar.
(No entries) When surrogate registration flag is
disabled or when de-registration has completed
successfully.
sipArsStatus
N/A
Address Reachability Service status with following results:
<sigZoneId>
recordIndex
sigPortNum
endpointIpAddress
endpointIpPortNum
endpointArsState
blacklisted The endpoint has been blacklisted
because the criteria outlined in the ARS profile blacklist
algorithm were met.
monitoring The endpoint is considered as being
monitored because a timeout has been received from
the endpoint but the blacklist criteria has not yet been
met (the profile requires a set number of timeouts over
a specific time frame to transition to blacklisted state).
recovering The OPTIONS ping criteria for endpoint
reachability detection requires that x amount of
successful responses are received over a specified
time frame before moving from the black list. During the
time that a response has been received but the
timeframe/number of successful responses has not
been completed, the end point is considered in a
recovering state.
endpointStateTransitionTime
2 62

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
SIP TG current SIP statistics. with following results:

rcvInvite Total number of (interval) received Invite
messages.
rcvAck Total number of (interval) Received Ack
messages.
sndBye Total number of (interval) sent Bye messages.
rcvCancel Total number of (interval) received Cancel
messages.
snd18x Total number of (interval) sent 18x messages.
rcv1xx Total number of (interval) received 1xx
messages (except 18x).
snd1xx Total number of (interval) sent 1xx messages
(except 18x).
rcv2xx Total number of (interval) received 2xx (Invite)
messages.
snd2xx Total number of (interval) sent 2xx (Invite)
messages.
rcvNonInv2xx Total number of (interval) received 2xx
(NonInvite) messages.
sndNonInv2xx Total number of (interval) sent 2xx
byeRetransmit Total number of (interval) Bye
messages ReTransmitted.
cancelReTransmit Total number of (interval) Cancel
otherReTransmit Total number of (interval) Other
numberOfCallsSendingAARs Number of calls
sending AAR requests.
numberOfReceivedAAAFailures Number of
received AAA failures.
numberOfTotalAARSent Total number of AAR
messages sent.
numberOfTimeoutOrErrorAAR Number of AAR
messages not answered.

2 63
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
The SIP trunk group interval SIP statistics. Options are:

byeRetransmit Total number of (interval) Bye
cancelReTransmit Total number of (interval) Cancel
emergencyAccept Total number of (interval)
emergency calls accepted.
emergencyRejectBWCall Total number of (interval)
emergency calls rejected because of bandwidth limit or
call limit.
emergencyRejectPolicer Total number of (interval)
emergency calls rejected because of Priority Policer.
hpcAccept Total number of (interval) HPC calls
accepted.
true
false
invReTransmit Total number of (interval) Invite
messages Re-transmitted.
otherReTransmit Total number of (interval) Other
rcv1xx Total number of (interval) received 1xx msg
except 18x messages.
rcv2xx Total number of (interval) received 2xx (Invite)
messages.
messages.
messages.
rcv5xx Total number of (interval) receive 5xx
messages.
rcv6xx Total number of (interval) receive 6xx
messages.
rcv18x Total number of (interval) received 18x
messages.
rcvAck Total number of (interval) received Ack.
rcvBye Total number of (interval) received Bye
messages.
rcvCancel Total number of (interval) received Cancel
messages.
2 64

CLI Reference Guide

System Commands

Parameter
(continued)
Length/
Range Description
N/A
rcvInfo Total number of (interval) received INFO

messages.
rcvInvite Total number of (interval) received Invite
messages.
rcvMessage Total number of (interval) received
Message method.
rcvNonInv2xx Total number of (interval) received
2xx (NonInvite) messages.
rcvNonInvErr Total number of (interval) receive
NonIvite Error messages.
rcvNotify Total number of (interval) receive notify
messages.
rcvOption Total number of (interval) receive Option
messages.
rcvPrack Total number of (interval) received Prack
messages.
rcvPublish Total number of (interval) received Publish
method.
rcvRefer Total number of (interval) received Refer
messages.
rcvRegister Total number of (interval) received
Register messages.
rcvSubscriber Total number of (interval) receive
Subscriber messages.
rcvUnknownMsg Total number of (interval) receive
Unknown messages.
rcvUpdate Total number of (interval) received Update
messages.
regReTransmit Total number of (interval) Register
messages re-transmitted.
snd1xx Total number of (interval) sent 1xx msg except
18x messages.
snd2xx Total number of (interval) sent 2xx (Invite)
messages.
snd3xx Total number of (interval) sent 3xx messages.
snd18x Total number of (interval) sent 18x messages.
sndAck Total number of (interval) Sent Ack messages.
sndBye Total number of (interval) sent Bye messages.
sndCancel Total number of (interval) sent Cancel
messages.

2 65
CLI Reference Guide

System Commands

Parameter
(continued)
Length/
Range Description
N/A
sipOcsCallCurrentStatist N/A
ics
2 66
sndInfo Total number of (interval) sent INFO

messages.
sndInvite Total number of (interval) sent Invite
messages.
sndMessage Total number of (interval) sent Message
method.
sndNonInv2xx Total number of (interval) sent 2xx
sndNonInvErr Total number of (interval) sent NonIvite
Error messages.
sndNotify Total number of (interval) sent Notify
messages.
sndOption Total number of (interval) sent Option
messages.
sndPrack Total number of (interval) sent Prack
messages.
sndPublish Total number of (interval) sent Publish
method.
sndRefer Total number of (interval) sent Refer
messages.
sndRegister Total number of (interval) sent Register
messages.
sndSubscriber Total number of (interval) sent
Subscriber messages.
sndUpdate Total number of (interval) sent Update
messages.
time The system up time when the interval statistics is
collected.
The SIP trunk group current SIP OCS call statistics.
attemptedCalls Number of attempted OCS call
statistics.
establishedCalls Number of established OCS call
statistics.
failedCalls Number of failed OCS call statistics.
pendingCalls Number of pending OCS call statistics.
rejectedCalls Number of SBC rejected OCS call
statistics.
relayedCalls Number of relayed OCS invite to
Engress side statistics.
successfulCalls Number of successful OCS call
statistics.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
sipOcsCallIntervalStatis N/A
tics
sipPeerCacStatus
N/A
The SIP trunk group interval SIP statistics.

<counter> A counter associated with a performance
measurement in 15-minute intervals. The value starts
from zero and increases when associated events occur
until the end of the interval. At that time, the value of the
counter is stored in the first 15-minute history interval, and
the CurrentCount is restarted at zero. In the case where
the agent has no valid data available for the current
interval, the corresponding object instance is not available
and upon a retrieval request a corresponding error
message is returned to indicate this instance does not
exist (for example, a noSuchName error for SNMPv1 and
a noSuchInstance for SNMPv2 GET operation).
attemptedCalls Current Attempted OCS call
statistics.
establishedCalls Current Established OCS call
statistics.
failedCalls Current Failed OCS call statistics.
intervalValid The member indicating the validity of the
interval.
pendingCall Current Pending OCS call statistics.
rejectedCall Current Rejected OCS call statistics.
relayedCalls Current Relayed OCS invite to Egress
side statistics.
successfulCalls Current Successful OCS call
statistics.
collected.
Status for SIP peers with endpoint CAC configured.
<peer_name> Name of SIP peer.
bandwidthRejectsLimit Number of calls rejected
due to bandwidth CAC.
createdAt The date and GMT time at which this peer
control was created.
egressCallRejectsLimit Number of egress calls
rejected due to endpoint CAC call limits.
egressCallRejectsRate Number of egress calls
rejected due to endpoint CAC call rate.
egressCallsActive Number of egress calls currently
active for peer.
egressCallsAllowed Number of egress calls
allowed for this peer.
egressDblAggregateMessageRejectsRate
Number of egress aggregate message rejected due to
endpoint CAC call rate.

2 67
CLI Reference Guide

System Commands

Parameter
sipPeerCacStatus
(continued)
2 68
Length/
Range Description
N/A
egressDblAggregateMessagesAllowed Number of
egress aggregate message allowed for this peer.
egressMessageRejectsRate Number of egress
message rejected due to endpoint CAC call rate.
egressMessagesAllowed Number of egress
message allowed for this peer.
egressNotifyRejectsRate Number of egress notify
egressNotifysAllowed Number of egress notify
egressOptionsAllowed Number of egress options
egressOptionsRejectsRate Number of egress
options rejected due to endpoint CAC call rate.
egressOtherRequestsAllowed Number of egress
other requests allowed for this peer.
egressOtherRequestsRejectsRate Number of
egress other requests rejected due to endpoint CAC call
rate.
egressReferRejectsRate Number of egress refer
egressRefersAllowed Number of egress refer
egressResponseRejectsRate Number of egress
response rejected due to endpoint CAC call rate.
egressResponsesAllowed Number of egress
response allowed for this peer.
egressSubscribeRejectsRate Number of egress
subscribe rejected due to endpoint CAC call rate.
egressSubscribesAllowed Number of egress
subscribe allowed for this peer.
ingressCallRejectsLimit Number of ingress calls
rejected due to endpoint CAC call limits.
ingressCallRejectsRate Number of ingress calls
ingressCallsActive Number of ingress calls
currently active for peer.
ingressCallsAllowed Number of ingress calls
ingressDblAggregateMessageRejectsRate
Number of ingress aggregate message rejected due to
endpoint CAC call rate.

CLI Reference Guide

System Commands

Parameter
sipPeerCacStatus
(continued)
Length/
Range Description
N/A
ingressDblAggregateMessagesAllowed Number
of ingress aggregate message allowed for this peer.
ingressMessageRejectsRate Number of ingress
message rejected due to endpoint CAC call rate.
ingressMessagesAllowed Number of ingress
message allowed for this peer.
ingressNotifyRejectsRate Number of ingress
notify rejected due to endpoint CAC call rate.
ingressNotifysAllowed Number of ingress notify
ingressOptionsAllowed Number of ingress options
ingressOptionsRejectsRate Number of ingress
options rejected due to endpoint CAC call rate.
ingressOtherRequestsAllowed Number of ingress
other requests allowed for this peer.
ingressOtherRequestsRejectsRate Number of
ingress other requests rejected due to endpoint CAC call
rate.
ingressReferRejectsRate Number of ingress refer
ingressRefersAllowed Number of ingress refer
ingressResponseRejectsRate Number of ingress
response rejected due to endpoint CAC call rate.
ingressResponsesAllowed Number of ingress
response allowed for this peer.
ingressSubscribeRejectsRate Number of ingress
subscribe rejected due to endpoint CAC call rate.
ingressSubscribesAllowed Number of ingress
subscribe allowed for this peer.
state Current state of the signaling peer control.
deleted
disabled
enabled
none
type Identifies the TYPE of signaling peer.

2 69
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
sipRegAdaptiveNaptLearni N/A
ngStatistics
N/A
Adaptive NAPT pinhole timer learning statistics.

sessionAdmissionReject Number of learning
sessions rejected.
sessionsAbortedDueToTraffic Number of
learning sessions aborted due to traffic.
sessionsCompleted Number of learning sessions
completed.
sessionsCompletedDueToTimeout Number of
learning sessions completed due to OPTIONS timeout.
sessionsInProgress Number of learning sessions in
progress.
sessionsInitiated Number of learning sessions
initiated.
sessionsReachedRelearnThreshold Number of
learning session reached the relearning threshold
Specifies SIP Signaling port connection statistics.
activeTlsTcpConnection Number of current TLSTCP connections made.
tcpConnection Number of current TCP connections.
totalTcpConnection Number of total TCP
connections made.
totalTlsTcpConnection Number of total TLS-TCP
connections.
sipSigConnStatus
N/A
SIP Signaling Port connection status data.

aging Specifies whether or not an idle connection can
be taken down.
bytesRcvd Number of payload bytes received on
connection.
bytesSent Number of payload bytes sent on the
connection.
idleTime Time internal since the last activity.
index Specifies the index of this SIP Signaling Port.
pduRecvQueued Number of fragmented PDUs
received on the connection.
pduSendQueued Number of PDUs waiting to be sent.
peerIpAddress IP address of the peer.
peerPortNum Specifies the port number used by the
peer of this connection.
role Role taken by the SBC 5x00 in this connection.
socket Socket number used internally for connection.
state State of this connection.
transport Transport type used for the connection.
2 70

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
Specifies the SIP Signaling port statistics. Options are:

callRate Number of SIP calls per second during the
last minute.
inRegs Total number of inbound registration(s)
received.
origCalls Total number of outgoing calls sent.
outRegs Total number of outbound registration(s) sent.
rxBytes Total number of signaling BYTES received.
rxPdus Total number of signaling PDUs received.
termCalls Total number of incoming calls received.
txBytes Total number of signaling BYTES sent.
txPdus Total number of signaling PDUS sent.
sipSigPortStatus state
N/A
The SIP signaling port status:

inService
outOfService
N/A
Specifies the SIP Signaling TLS connection statistics.

clientAuthFailures Number of times peer failed
TLS authentication with SBC as the client.
currentClientHandshakes Number of incomplete
client handshakes.
currentClientSessions Number of client sessions
currently active.
currentServerHandshakes Number of incomplete
server handshakes.
currentServerSessions Number of server sessions
currently active.
currentSuspendedSessions Number of server
sessions currently suspended.
fatelAlertsReceived Number of FATAL Alerts
received.
handshakeFailures Cumulative total of all
handshake failures.
handshakeTimeouts Number of handshakes that
timed out before completing.
higherAuthTimeout 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 Number times a peer sent a
TLS Hello on a connection that was already up
noAuth488 Number of SIP messages rejected with 488
due to lack of peer authentication at the SIP level.

2 71
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
(continued)
N/A
noAuthDrops Number of SIP messages dropped due

to lack of peer authentication at the SIP level.
noCipherSuite Number of handshake failures due to
inability to converge on a cipher suite.
noClientCert Number times we were the client and
we failed to derive a certificate to send the server.
receiveFailures Number of receive failures (failure
to decrypt).
sendFailures Number of send failures (failure to
encrypt).
serverAuthFailures Number of times peer failed
TLS authentication with SBC as the server.
sessionResumptions Number of server sessions
that have been resumed.
totalClientSessions Cumulative total number of
client sessions.
totalServerSessions Cumulative total number of
server sessions.
warningAlertsReceived Number of WARNING
Alerts received.
N/A
SIP signaling port connection status data.

bytesRcvd Number of payload bytes received on this
session.
bytesSent Number of payload bytes sent on this
session
index The index of this SIP Signaling Port.
peerIpAddress IP address of the peer of this
connection.
recordsRcvd Number of TLS records received on this
session.
recordsSent Number of TLS records sent on this
session.
resumptions Number of times this session has been
resumed.
role The role taken by the SBC in this connection.
sessionId Identifies the TLS session ID.
state State of this connection. Options:
blocked|connected|connecting|deleted|negot
iating|none|suspended|up|waitingSipAuth
2 72

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
sonusSipSigPeerOvldStatu N/A
sEntry
SIP signaling peer overload status.
trafficControlCurrentSta N/A
tistics
The trunk group current traffic control statistics.
sonusSipSigPeerOvldStatus503sReceived
Number of 503s received in the last sampling period.
sonusSipSigPeerOvldStatusAllowedRate Rate
of calls allowed per second for this peer.
sonusSipSigPeerOvldStatusCallsRejected
Number of calls rejected in the last sampling period for
peer.
sonusSipSigPeerOvldStatusCallsSent Number
of calls sent in the last sampling period for peer.
sonusSipSigPeerOvldStatusZoneId The Zone Id
for this signaling peer.
accCant The current number of calls cancelled due to
ACC for this trunk group.
accSkip The current number of calls skipped due to
ACC for this trunk group.
canf The current number of call cancelled due to CANF
cant The current number of call cancelled due to CANT
routeAttemptsIRR The current number of reroute
attempts due to IRR for this trunk group.
routeAttemptsORR The current number of reroute
attempts due to ORR for this trunk group.
routeAttemptsSIRR The current number of reroute
attempts due to SIRR for this trunk group.
routeAttemptsSORR The current number of reroute
attempts due to SORR for this trunk group.
silc The current number of calls cancelled due to SILC
skip The current number calls skipped due to the SKIP
traffic control for this trunk group.
strCant The current number of call cancelled due to
STR for this trunk group.
strSkip The current number of calls skipped due to
STR for this trunk group.
successfulIRR The current number of successful
reroutes due to IRR for this trunk group.
successfulORR The current number of successful
reroutes due to ORR for this trunk group.
successfulSIRR The current number of successful
reroutes due to SIRR for this trunk group.
successfulSORR The current number of successful
reroutes due to SORR for this trunk group.

2 73
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
trafficControlIntervalSt N/A
atistics
2 74
The trunk group interval traffic control statistics.

<counter> Counter associated with performance
measurement in a current 15-minute measurement
interval.
accCant The number of calls cancelled due to ACC for
accSkip The number of calls skipped due to ACC for
canf The number of calls cancelled due to CANF for
cant The number of calls cancelled due to CANT for
intervalValid The member indicating the validity of
the interval.
routeAttemptsIRR The number of reroute attempts
due to IRR for this trunk group for the specified interval.
routeAttemptsORR The number of reroute attempts
due to ORR for this trunk group for the specified interval.
routeAttemptsSIRR The number of reroute attempts
due to SIRR for this trunk group for the specified interval.
routeAttemptsSORR The number of reroute attempts
due to SORR for this trunk group for the specified interval.
silc The number of calls cancelled due to SILC for this
skip The number calls skipped due to the SKIP traffic
control for this trunk group for the specified interval.
strCant The number of calls cancelled due to STR for
strSkip The number of calls skipped due to STR for
successfulIRR The number of successful reroutes
due to IRR for this trunk group for the specified interval.
successfulORR The number of successful reroutes
due to ORR for this trunk group for the specified interval.
successfulSIRR The number of successful reroutes
due to SIRR for this trunk group for the specified interval.
successfulSORR The number of successful reroutes
due to SORR for this trunk group for the specified interval.
time System up time when interval statistic is collected.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
trunkGroupQoeStatus
N/A
Quality of Experience (QoE) metric for IP trunk groups in

zone.
asrCriticalThresholdExceeded Number of times
the ASR Critical threshold was breached.
asrFromSBXBOOT Average ASR for TG from system
boot.
asrMajorThresholdExceeded Number of times the
ASR Major threshold was breached.
currentASR Average ASR for the TG.
currentPgrd Average post-gateway ringing delay
value of TG.
egressActiveCalls Number of active calls on TG.
egressSustainedCallRate Sustained call rate for
TG.
inboundRFactor Average RFactor for inbound
streams.
inboundRFactorFromSBXBOOT Average RFactor for
the inbound streams from system startup.
inboundRFactorNumCriticalThresholdBreached
Number of times Critical threshold was breached
(inbound RTP streams).
inboundRFactorNumMajorThresholdBreached
Number of times Major threshold was breached (inbound
RTP streams).
outboundRFactor Average RFactor for the outbound
streams.
outboundRFactorFromSBXBOOT Average RFactor
for the outbound streams from system startup.
outboundRFactorNumCriticalThresholdBreached
Number of times Critical threshold was breached
(outbound RTP streams).
outboundRFactorNumMajorThresholdBreached
Number of times Major threshold was breached
(outbound RTP streams).
qosDropCount Number of times route was dropped
due to KPI threshold breach.

2 75
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
trunkGroupStatus
N/A
Status for IP trunk groups in this zone. Options are:

bwAvailable Bandwidth available for allocation.
bwCurrentLimit Current bandwidth limit for this IP
trunk group.
bwInboundUsage Bandwidth inbound traffic usage.
bwOutboundUsage Bandwidth outbound traffic usage.
inboundCallsUsage Inbound call usage (for IP trunk
groups configured for inbound or in both directions).
outboundCallsUsage Current outbound, non-priority
usage count of this IP trunk group.
packetOutDetectState The packet outage detection
status.
priorityCallUsage Indicates priority call usage for
IP trunk groups configured with call reserved state
enabled.
state Current operational state of the IP trunk group.
totalCallsAvailable Sum of all available or
unblocked calls for this trunk group.
totalCallsConfigured Total number of calls
configured on this IP trunk group.
N/A
trunkGroupStatus
(continued)
totalCallsInboundReserved Total number of calls

on reserved inbound trunks (for IP trunk groups that are
configured for inbound or in both directions).
totalOutboundCallsReserved Total number of
calls on reserved outbound trunks (for IP trunk groups that
are configured for outbound or in both directions).
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;
}
ipAclRulesByPrecedence 1 {
2 76

CLI Reference Guide

System Commands
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
{
minTime 0;
maxTime 0;

2 77
CLI Reference Guide

System Commands
averageTime 0;
singleFailures 0;
doubleFailures 0;
failures 1;
replies 0;
duplicateReplies 0;
lateReplies 0;
}
alarms
To display status of alarms:
> show status alarms currentStatus
clearType
desc <desc>
reporter <reporter>
severity <severity>
timestamp <timestamp>
> show status alarms historyStatus <historyStatus>
desc <desc>
reporter <reporter>
severity <severity>
state <state>
timestamp <timestamp>
> show status alarms historyStatus
TABLE 2 18 show status alarms Parameters
Parameter
Length/
Range
currentStatus
N/A
Description
Displays the Status table for current outstanding alarms.
clearType The type of alarm clearing (AUTOMATIC or
MANUAL).
desc Alarm description.
reporter Name of task reporting alarm.
severity Alarm severity level.
timestamp Timestamp of when alarm was raised.
historyStatus
N/A
Status table for History-Alarms.
2 78
desc Alarm description.

reporter Name of task reporting alarm.
severity Alarm severity level.
state Alarm state (SET, CLEAR, OR MAN CLR)
timestamp Timestamp of when alarm was raised.

CLI Reference Guide

System Commands
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]
global
To display status of global object:
> show status global cac
sharedCacCurrentStatistics
sharedCacFailureCurStats
sharedCacFailureIntStats
sharedCacIntervalStatistics
sharedCacStatus
> show status global policyServer
CdDNBasedDestAllowedTable
CdDNBasedDestBlockedTable
contractorBasedOrigAllowedTable
contractorBasedOrigBlockedTable
dialedDestAllowedTable
dialedDestBlockedTable
displaylevel
dnsEnumCounters
failureCounters
finalCallingNumberAllowedTable
finalCallingNumberBlockedTable
finalDestAllowedTable
finalDestBlockedTable
hpcCallsPerGsxTable
hpcExemptionGsxTable
lnpGsxTable
lnpTfCounters
mwiServiceCounters
2 79
CLI Reference Guide

System Commands
originationAllowedTable
originationBlockedTable
policyReqCounters
serviceUsageCounters
sipCounters
sipE911Counters
translatedDestAllowedTable
translatedDestBlockedTable
policyReqCounters
totalReqsNoExtSvc
totalTimeNoExtSvc
averageTimeNoExtSvc
totalRequestsExtSvc
totalTimeExtSvc
averageTimeExtSvc
extTime
averagExtTime
totalTimeouts
totalTimeTORequests
averageTimeTORequests
totalNonSsRequests
totalTimeNonSsRequests
averagTimeNonSsRequests
defaultSvcs
subsScreening
subsBlocking
nonSubsScreening
nonSubsBlocking
subsForcedRouting
subsHiFraudBlocking
subsSacNonSacRoutes
destNumForcedRouting
cicPhoneScreening
cicScreening
cicBlocking
cicForcedRouting
cicHiFraudBlocking
cicSacNonSacRoutes
tgScreening
tgBlocking
tgForcedRouting
tgHiFraudBlocking
tgSacNonSacRoutes
casualCallUnallowed
nonSubscriberCallsUnallowed
gwScreening
gwBlocking
gwForcedRouting
gwHiFraudBlocking
gwSacNonSacRoutes
2 80

CLI Reference Guide

System Commands
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
ENUMResponseInvalidParameter
ENUMResponseNoName
ENUMResponseNoData
DNSCanceledRequests
ENUMCanceledRequests
longTermAverageTransTime
shortTermAverageTransTime
NAPTRRscRecordReqSent
NAPTRRscRecordRspReceived
NAPTRRscRecordCanceledReq

2 81
CLI Reference Guide

System Commands
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
sipCounters
sipInviteSent
sip2xxRcvd
sip3xxRcvd
sip4xxRcvd
sip5xxRcvd
sip6xxRcvd
> show status global callCountStatus all
2 82

CLI Reference Guide

System Commands
> 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 callDetailStatus
addressTransPerformed
associatedGcid1
associatedGcid2
associatedGcid3
associatedGcid4
associatedGcid5a
ssociatedGcid6
associatedGcidLegId1
callDuration
calledNumber
callingNumber
egressLocalIpSockAddr
egressRemoteIpSockAddr
egressSrtcpAuth
egressSrtcpCrypto
egressSrtpAuth
egressSrtpCrypto
egressVideoLocalIpSockAddr
egressVideoRemoteIpSockAddr
ingressLocalIpSockAddr
ingressRemoteIpSockAddr
ingressSrtcpAuth
2 83
CLI Reference Guide

System Commands
ingressSrtcpCrypto
ingressSrtpAuth
ingressSrtpCrypto
ingressVideoLocalIpSockAddr
ingressVideoRemoteIpSockAddr
mediaType
origCalledNum
scenarioType
state
videoBandwidth
videoDuration
> show status global callMediaStatus
egressActAudioType
egressBearerType
egressCfgAudioType
egressInterarrivalJitter
egressMacHeader
egressOctetsReceived
egressOctetsSent
egressPacketLatency
egressPacketsDiscarded
egressPacketsLost
egressPacketsReceived
egressPacketsSent
egressVideoInterarrivalJitter
egressVideoOctetsReceived
egressVideoOctetsSent
egressVideoPacketLatency
egressVideoPacketsDiscarded
egressVideoPacketsLost
egressVideoPacketsReceived
gressVideoPacketsSent
egressVideoStatsValid
ingressActAudioType
ingressBearerType
ingressCfgAudioType
ingressInterarrivalJitter
ingressMacHeader
ingressOctetsReceived
ingressOctetsSent
ingressPacketLatency
ingressPacketsDiscarded
ingressPacketsLost
ingressPacketsReceived
ingressPacketsSent
ingressVideoInterarrivalJitter
ingressVideoOctetsReceived
ingressVideoOctetsSent
ingressVideoPacketLatency
ingressVideoPacketsDiscarded
ingressVideoPacketsLost
ingressVideoPacketsReceived
2 84

CLI Reference Guide

System Commands
ingressVideoPacketsSent
ingressVideoStatsValid
> show status global ipGeneralGroupStatistics
inReceives
inHdrErrors
inAddrErrors
inUnknownProtos
inDiscards
inDelivers
outRequests
outDiscards
outNoRoutes
reasmTimeout
reasmReqds
reasmOKs
reasmFails
fragOKs
fragFails
> 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

2 85
CLI Reference Guide

System Commands
bwOutboundUsage
displaylevel
inboundCallsUsage
outboundCallsUsage
packetOutDetectState
priorityCallUsage
state
totalCallsAvailable
totalCallsConfigured
totalCallsInboundReserved
totalOutboundCallsReserved
zone
TABLE 2 19 show status global Parameters
Parameter
Length/
Range
Description
cac
N/A
Defines global CAC objects.

sharedCacCurrentStatistics The shared CAClimits pool current statistics.
sharedCacFailureCurStats The shared CAC-limits
pool current failure statistics.
sharedCacFailureIntStats The shared CAC limits
pool interval failure statistics.
sharedCacIntervalStatistics The shared CAClimits pool statistics for the specified interval.
sharedCacStatus Current status of the shared CAClimits pool.
2 86

CLI Reference Guide

System Commands
TABLE 2 19 show status global Parameters (Continued)

Parameter
Length/
Range
Description
callCountStatus
N/A
Call count statistics for the server. Options are:

activeCalls Current number of active managed calls
on this server.
activeCallsNonUser Current number of active noncall associated signalling channels in the server.
callAttempts Number of call attempts on this server.
callCompletions Total number of completed call
attempts on this server.
callUpdates Number of call updates (modifications)
on this server. Due to the internal call processing logic, it
includes internal modifications too which may or may not
be triggered by the signaling messages.
stableCalls Current number of stable managed calls
on this server.
stableCallsNonUser Current number of stable noncall associated signalling channels in the server.
totalCalls Total number of calls on this server.
totalCallsEmergEstablishing Number of
establishing emergency calls.
totalCallsEmergStable Number of stable
emergency calls.
totalCallsNonUser Total number of non-user calls
on this server.
callDetailStatus
N/A
Displays the Call Detail Status table.
callMediaStatus
N/A
Displays Call Media Status table.
callResourceDetailStat
us
N/A
Displays Call Resource Detail Status table.
callSummaryStatus
N/A
Call summary status table.
globalTrunkGroupStatus
N/A
Status for IP trunk groups in this zone. (see Table 2 20 on

page 2 94 for details)

2 87
CLI Reference Guide

System Commands

Parameter
icmpGeneralGroupStatis
tics
Length/
Range
N/A
Description
Collection of ICMP General Group information for the
specified instance.
inDestUnreachs <#> Number of ICMP Destination
Unreachable messages received.
inEchoReps <#> Number of ICMP Echo Reply
messages received.
inEchos <#> Number of ICMP Echo (request)
messages received.
inErrors <#> Number of ICMP messages which the
entity received but determined as having ICMP-specific
errors (bad ICMP checksums, bad length).
inMsgs <#> Total number of ICMP messages which
the entity received.
outDestUnreachs <#> Number of ICMP Destination
Unreachable messages sent.
outEchoReps <#> Number of ICMP Echo Reply
messages sent.
outEchos <#> Number of ICMP Echo (request)
messages sent.
outErrors <#> Number of ICMP messages which this
entity did not send due to problems discovered within
ICMP such as a lack of buffers.
outMsgs <#> Total number of ICMP messages which
this entity attempted to send.
ipGeneralGroupStatisti
cs
N/A
Collection of IP General Group information for specified

instance. Options are:
fragFails Number of IP datagrams discarded
because they failed to fragment, e.g., because Don't
Fragment flag was set.
fragOKs Number of IP datagrams successfully
fragmented at this entity.
inAddrErrors Number of input datagrams discarded
because IP address in IP header's destination field was
not a valid address to receive at this entity.
inDelivers Total number of input datagrams
successfully delivered to IP user-protocols (including
ICMP).
inDiscards 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 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.
2 88

CLI Reference Guide

System Commands

Parameter
Length/
Range
Description
ipGeneralGroupStatisti
cs (continued)
N/A
inReceives Total number of input datagrams received

from interfaces, including those received in error.
inUnknownProtos Number of locally-addressed
datagrams received successfully but discarded because of
an unknown or unsupported protocol.
outDiscards 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 Number of IP datagrams discarded
because no route could be found to transmit them to their
destination.
outRequests Total number of IP datagrams which
local IP user- protocols (including ICMP) supplied to IP in
requests for transmission.
reasmFails Number of failures detected by IP reassembly algorithm (for reason such as time-out or error).
reasmOKs Number of IP datagrams successfully reassembled.
reasmReqds Number of IP fragments received which
needed to be reassembled at this entity.
reasmTimeout Maximum number of seconds which
received fragments are held while awaiting reassembly at
this entity.
monitorEndpointStatus
N/A
Status of MCT setting.
monitorTargetStatus
N/A
Status of the monitor target.
ocsCallCountStatus
N/A
Call count statistics for the Office Communications Server

(OCS). Additional OCS arguments:
policyServer
N/A
attemptedCall Total number of attempted Calls.

establishedCalls Total number of established calls.
failedCalls Total number of failed calls.
pendingCalls Total number of pending calls.
rejectedCalls Total number of rejected calls.
relayedCall Total number of relayed calls.
successfulCalls Total number of successful calls.
Specifies the policy server statistics. Options are:

CdDNBasedDestAllowedTable Traffic Managementrelated counters for allowed called DN based destination.
CdDNBasedDestBlockedTable Traffic Managementrelated counters for blocked called DN based destination.

2 89
CLI Reference Guide

System Commands

Parameter
policyServer
(continued)
2 90
Length/
Range
N/A
Description
contractorBasedOrigAllowedTable Traffic
Management-related counters for allowed contractor
number based origination.
contractorBasedOrigBlockedTable Traffic
Management-related counters for blocked contractor
number based origination.
dialedDestAllowedTable Traffic Managementrelated counters for allowed dialed destination number.
dialedDestBlockedTable Traffic Managementrelated counters for blocked dialed destination number.
dnsEnumCounters Policy DNS ENUM query
counters.(see Table 2 21 on page 2 95)
failureCounters Policy failure counters.
numExternalError Number of requests that
encountered an External Error.
numInternalError Number of requests that
encountered an Internal Error.
numQueryError Number of requests that
encountered an SQL Query Error.
finalCallingNumberAllowedTable Traffic
Management related counters for allowed final calling
number.
finalCallingNumberBlockedTable Traffic
Management related counters for blocked final calling
number.
finalDestAllowedTable Traffic Management
related counters for allowed final destination number.
finalDestBlockedTable Traffic Management
related counters for blocked final destination number.
hpcCallsPerGsxTable Ingress PSTN HPC Calls
related counters per SBC 5x00 table.
hpcExemptionGsxTable Traffic Management HPC
Exemption related counters per SBC 5x00 table.
lnpGsxTable LNP related counters per GSX table.
gsxInvalidNumbers Number of LNP-specific ISUP
release messages received by the GSX with cause 28
Invalid number format.
gsxMisroutedCalls Number of LNP-specific ISUP
release messages received by the GSX with cause 26
mis-routed call to a ported number.
gsxName GSX name to which the LNP Counters
apply.

CLI Reference Guide

System Commands

Parameter
policyServer
(continued)
Length/
Range
N/A
Description
lnpTfCounters Policy LNP and toll-free counters.
numDNRequests Number of LNP requests to ported
DNs.
numLNPRequests Total number of requests received
by the Sonus SoftSwitch requiring LNP translation.
numRequestErrors Number of LNP request errors
other than timeout received from the SCP.
numSCPRequests Number of LNP requests sent to
SCP: Total number of requests sent to the SCP for LNP
translation.
numTimedOutRequests Number of LNP requests
that timed out.
tfcNumRequestErrors Number of toll-free
requests that resulted in an error.
tfcNumRequests Total number of requests received
by the Sonus SoftSwitch requiring toll-free translation.
tfcNumRequestsToScp Total number of requests
sent to the SCP for translation.
tfcNumRequestsTranslated Number of toll-free
requests successfully translated.
tfcNumTimedOutRequests Number of toll-free
requests that timed out.
mwiServiceCounters Policy Message Waiting
Indicator service counters.
MWIService This counter tracks calls that execute
MWI service.
MWIUpdateService This counter tracks calls that
execute MWI Status Update service.
originationAllowedTable Number of calls for
which a origination number with a provisioned Traffic
control was allowed to complete.
originationBlockedTable Number of calls for
which an origination number with a provisioned Traffic
control was blocked.
policyReqCounters Policy request counters.(see
Table 2 22 on page 2 97 for additional arguments).
serviceUsageCounters Policy service usage
counters. (see Table 2 23 on page 2 98 for additional
arguments)

2 91
CLI Reference Guide

System Commands

Parameter
policyServer
(continued)
2 92
Length/
Range
N/A
Description
sipCounters Policy SIP message counters.
sip2xxRcvd Counter that tracks the number of 2XX
responses which have been received by SCPA process.
responses which have been received by SCPA process
for INVITE transactions.
sipInviteSent Counter that tracks the number of
INVITE requests which have been sent by SCPA
process.
sipE911Counters Policy E911 service counters.
failedRspRcvd Counter that tracks number of
failed Emergency Services Routing Responses
(ESRRsp) received by the ERE.
reqRetry Counter that tracks number of Emergency
Services Routing Requests (ESRReq) retransmitted by
the ERE.
reqSent Counter that tracks number of Emergency
Services Routing Requests (ESRReq) sent by the ERE.
successfulRspRcvd Counter that tracks number
of successful Emergency Services Routing Responses
(ESRRsp) received by the ERE.
totalRspRcvd Counter that tracks total number of
Emergency Services Routing Responses (ESRRsp)
received by the ERE.
translatedDestAllowedTable Traffic
Management-related counters for allowed translated
destination number.
translatedDestBlockedTable Traffic
Management-related counters for blocked translated
destination number.

CLI Reference Guide

System Commands

Parameter
tcpGeneralGroupStatist
ics
Length/
Range
N/A
Description
Collection of TCP general group information for the specified
clientConnections Number of times TCP
connections have made a direct transition to the SYNSENT state from the CLOSED state.
establishedConnections Number of TCP
connections for which the current state is either
ESTABLISHED or CLOSE- WAIT.
failedAttempts 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 Total number of segments received in error
(example, bad TCP checksums).
inResets 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 Total number of segments received,
including those received in error.
outResets Number of TCP segments sent containing
the RST flag.
outSegments Total number of segments sent, including
those on current connections but excluding those
containing only retransmitted octets.
retransSegments Total number of segments
retransmitted (i.e. number of TCP segments transmitted
containing one or more previously transmitted octets).
serverConnections Number of times TCP
connections have made a direct transition to the SYNRCVD state from the LISTEN state.
udpGeneralGroupStatist
ics
N/A
Collection of UDP general group information for the specified

inDatagrams Total number of UDP datagrams
delivered to UDP users.
inErrors Number of received UDP datagrams that
could not be delivered for reasons other than the lack of
an application at the destination port.
outDatagrams Total number of UDP datagrams sent
from this entity.
unknownPorts Total number of received UDP
datagrams for which there was no application at the
destination port.

2 93
CLI Reference Guide

System Commands
TABLE 2 20 show status global globalTrunkGroupStatus Parameters

Parameter
Length/
Range Description
globalTrunkGrou
pStatus
N/A
Use this object to specify status for IP trunk groups in this zone.
Parmeter options are listed below.
addressContext
N/A
The name of address context for this trunk group.

NOTE: The characters #%^&(){}<>,/\;`[]=!$'*?|~ and SPACE are not
allowed.
bwAvailable
0-64
Specifies how much bandwidth is available for allocation.
bwCurrentLimit
N/A
Current bandwidth limit for this IP trunk group.
bwInboundUsage
N/A
The amount of bandwidth in use for inbound traffic.
bwOutboundUsage
N/A
Amount of bandwidth in use for outbound traffic.
inboundCallsUsa
ge
N/A
The amount of inbound call usage. This is only meaningful for IP trunk
groups that are configured for inbound or both directions.
outboundCallsUs
age
N/A
Current outbound, non-priority usage count of this IP trunk group.
packetOutDetect
State
N/A
This object indicates the packet outage detection state. Possible values:
priorityCallUsa
ge
N/A
state
N/A
normal
packetOutageState
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
totalCallsAvail
able
N/A
The sum of all available or unblocked calls for this trunk group.
totalCallsConfi
gured
N/A
This object reflects the total number of calls that are configured on this IP
trunk group.
totalCallsInbou
ndReserved
N/A
This is meaningful for IP trunk groups that are configured for inbound or
both directions only.
totalOutboundCa
llsReserved
N/A
This is meaningful for IP trunk groups that are configured for incoming
call reservation.
zone
N/A
The name of zone for this trunk group.

NOTE: The characters #%^&(){}<>,/\;`[]=!$'*?|~ and SPACE are not
allowed.
2 94

CLI Reference Guide

System Commands
TABLE 2 21 show status global policyServer dnsEnumCounters Parameters

Parameter
Length/
Range Description
dnsEnumCounters
N/A
Specifies the policy DNS ENUM query

counters. Parameters associated with this
object are listed below in this table.
AResourceRecordCanceledRequests
N/A
Number of DNS A Resource Record requests

canceled by ERE.
AResourceRecordRequestsSent
N/A
Number of DNS A Resource Record requests

sent by ERE.
AResourceRecordResponsesReceived
N/A
Number of DNS A Resource Record

responses received by ERE.
AResourceRecordRspHostNotFound
N/A

Responses with Host_Not_Found Failure.
AResourceRecordRspNoData
N/A

Responses with
Valid_Name_But_No_Data_Record Failure.
AResourceRecordRspNoRecovery
N/A

Responses with
Non_Recoverable_Name_Server_Error
Failure.
AResourceRecordRspSuccess
N/A
Number of Successful DNS A Resource

Record Responses.
AResourceRecordRspTryAgain
N/A

Responses with
Temporary_Server_Error_Try_Again Failure.
CNAMRequestsSent
N/A
Total number of ENUM requests sent for

CNAM by ERE.
DNSCanceledRequests
N/A
Total number of DNS requests canceled by

ERE.
DNSRequestsSent
N/A
Total number of DNS requests sent by ERE.
NSResponsesReceived
N/A
Total number of DNS responses received by

ERE.
ENUMCanceledRequests
N/A
Total number of ENUM requests canceled by

ERE.
ENUMRequestsSent
N/A
Total number of ENUM requests sent for SIP

AoR by ERE.
ENUMResponseGeneralFailure
N/A
Total number of ENUM responses with General

Failure.
ENUMResponseInvalidParameter
N/A
Total number of ENUM responses with

Invalid_Parameter Failure.
ENUMResponseNoData
N/A

ENUMResponseNoMemory
N/A

Memory_Unavailable Failure.
ENUMResponseNoName
N/A

Name_Does_Not_Exist Failure.

2 95
CLI Reference Guide

System Commands
TABLE 2 21 show status global policyServer dnsEnumCounters Parameters (Continued)

Parameter
Length/
Range Description
ENUMResponseSuccess
N/A
Total number of Successful ENUM responses.
ENUMResponsesReceived
N/A
Total number of ENUM responses received by

ERE.
KARequestsSent
N/A
Total number of KeepAlive requests sent by

PES.
KAResponsesReceived
N/A
Total number of KeepAlive responses received

by ERE.
LNPRequestsSent
N/A
Total number of ENUM requests sent for LNP

by ERE.
NAPTRResourceRecordRspInvalidParam N/A
Number of DNS NAPTR Resource Record

responses with Invalid_Parameter Failure.
NAPTRResourceRecordRspNoData
N/A

responses with
NAPTRResourceRecordRspNoName
N/A

responses with Name_Does_Not_Exist
Failure.
NAPTRRscRecordCanceledReq
N/A

requests canceled by ERE.
NAPTRRscRecordReqSent
N/A

requests sent by ERE.
NAPTRRscRecordRspGeneralFailure
N/A

responses with General Failure.
NAPTRRscRecordRspNoMemory
N/A

responses with Memory_Unavailable Failure.
NAPTRRscRecordRspReceived
N/A

NAPTRRscRecordRspSuccess
N/A
Number of Successful DNS NAPTR Resource

Record responses.
SRVResourceRecordCanceledRequests
N/A
Number of DNS SRV Resource Record

requests canceled by ERE.
SRVResourceRecordRequestsSent
N/A

requests sent by ERE.
SRVResourceRecordResponsesReceived N/A

SRVResourceRecordRspGeneralFailure N/A

responses with General Failure.
SRVResourceRecordRspInvalidParam
N/A

responses with Invalid_Parameter Failure.
SRVResourceRecordRspNoData
N/A

responses with
SRVResourceRecordRspNoMemory
N/A

responses with Memory_Unavailable Failure.
2 96

CLI Reference Guide

System Commands
TABLE 2 21 show status global policyServer dnsEnumCounters Parameters (Continued)

Parameter
Length/
Range Description
SRVResourceRecordRspNoName
N/A

responses with Name_Does_Not_Exist
Failure.
SRVResourceRecordRspSuccess
N/A
Number of Successful DNS SRV Resource

Record responses.
longTermAverageTransTime
N/A
Specifies the long term average of transaction

time.
shortTermAverageTransTime
N/A
Short term average of transaction time.
TABLE 2 22 show status global policyServer policyRegCounter Parameters

Parameter
Length/
Range Description
policyReqCounters
N/A
Displays the policy request counters. Additional arguments

are listed in this table.
averagExtTime
N/A
Average time (in milliseconds) that it took in the external

service to process each request.
averagTimeNonSsRequests N/A
Average time (in milliseconds) to process each of these nonpolicy requests.
averagTimeExtSvc
N/A
Average time (in milliseconds) it took to process each of these

requests.
averagTimeNoExtSvc
N/A
Average amount of time (in milliseconds) to process each

individual request.
averagTimeToRequests
N/A
Average time taken to process each timed out request.
extTime
N/A
Total time (in milliseconds) external service to process all of

these requests.
totalNonSsRequests
N/A
Total number of non-policy requests.
totalReqsNoExtSvc
N/A
The total number of policy requests (excluding those needing

external services such as an SCP look-up) which were
handled by the Soft Switch.
totalRequestsExtSvc
N/A
Total requests (External Svc): The number of requests which

used an external service.
totalTimeExtSvc
N/A
Total time (in milliseconds) to process the requests that

required an external service.
totalTimeNoExtSvc
N/A
The total time (number of milliseconds) taken to process these

requests.
totalTimeNoSsRequests
N/A
The total time (in milliseconds) to process these non-policy

requests.
totalTimeTORequests
N/A
The total time (in milliseconds) to process the timed out

requests in the Softswitch.
totalTimeouts
N/A
The total number of external service requests which timed out.
2 97
CLI Reference Guide

System Commands
TABLE 2 23 show status global policyServer serviceUsageCounters Parameters

Parameter
Length/
Range Description
N/A
Specifies the policy service usage counters. Additional

arguments to this parameter are listed in this table.
authcodeBlocking
N/A
Counter that tracks number of times the Authcode

Blocking service is executed.
authcodeForcedRouting
N/A
Counter that tracks the number of times the Authcode

Forced Routing service is executed.
authcodeHiFraudBlocking
N/A
Counter that tracks number of times the Authcode

HiFraud Blocking service is executed.
authcodeSacNonSacRoutes
N/A

SAC/Non-SAC Routing service is executed.
authcodeScreening
N/A

Screening Service is executed.
casualCallUnallowed
N/A
Counter that tracks number of times casual calls are not

allowed through the network.
cicBlocking
N/A
Counter that tracks the number of times CIC Blocking

Service is executed.
cicForcedRouting
N/A
Counter that tracks the number of times CIC Forced

Routing Service is executed.
cicHiFraudBlocking
N/A
Counter that tracks the number of times CIC HiFraud

Blocking Service is executed.
cicPhoneScreening
N/A
Counter that tracks number of times incoming phone

type calls are not allowed.
cicSacNonSacRoutes
N/A
Counter that tracks number of times CIC SAC/Non-SAC

cicScreening
N/A
Counter that tracks number of times CIC Screening

defaultSvcs
N/A
Counter that tracks number of times default service is

executed.
destNumForcedRouting
N/A
Counter that tracks number of times Destination Number

Forced Routing Service is executed.
gwBlocking
N/A
Counter that tracks number of times Gateway Blocking

gwForcedRouting
N/A
Counter that tracks number of times Gateway Forced

gwHiFraudBlocking
N/A
Counter that tracks number of times Gateway HiFraud

gwSacNonSacRoutes
N/A
Counter that tracks number of times Gateway SAC/NonSAC Routing Service is executed.
gwScreening
N/A
Counter that tracks number of times Gateway

infodigitBlocking
N/A
Counter that tracks number of times the Infodigit

2 98

CLI Reference Guide

System Commands
TABLE 2 23 show status global policyServer serviceUsageCounters Parameters (Continued)

Parameter
Length/
Range Description
infodigitForcedRouting
N/A
Counter that tracks number of times the Infodigit Forced

Routing service is executed.
infodigitHiFraudBlocking
N/A

infodigitSacNonSacRoutes
N/A
Counter that tracks number of times the Infodigit SAC/

Non-SAC Routing service is executed.
infodigitScreening
N/A

nonSubsBlocking
N/A
Counter that tracks number of times Subscriber Blocking

nonSubsScreening
N/A
Counter that tracks number of times Non Subscriber

nonSubscriberCallsUnallowed N/A
Counter that tracks number of times non subscriber calls

are not allowed through the network.
softswitchBlocking
N/A
Counter that tracks number of times the SoftSwitch

softswitchForcedRouting
N/A

Forced Routing service is executed.
softswitchHiFraudBlocking
N/A

softswitchSacNonSacRoutes
N/A

SAC/Non-SAC Routing service is executed.
softswitchScreening
N/A

subsBlocking
N/A
Counter that tracks number of times Subscriber Blocking

subsForcedRouting
N/A
Counter that tracks number of times Subscriber Forced

subsHiFraudBlocking
N/A
Counter that tracks number of times Subscriber HiFraud

subsSacNonSacRoutes
N/A
Counter that tracks number of times Subscriber SAC/

Non-SAC Routing Service is executed.
subsScreening
N/A
Counter that tracks number of times Subscriber

tgBlocking
N/A
Counter that tracks number of times Trunkgroup

tgForcedRouting
N/A
Counter tracks number of times Trunkgroup Forced

tgHiFraudBlocking
N/A

HiFraud Blocking Service is executed.
tgSacNonSacRoutes
N/A
Counter that tracks number of times Trunkgroup SAC/

Non-SAC Routing Service is executed.
tgScreening
N/A


2 99
CLI Reference Guide

System Commands
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;
totalOutboundCallsReserved 0;
bwCurrentLimit -1;
bwAvailable -1;
bwInboundUsage 0;
bwOutboundUsage 0;
packetOutDetectState normal;
addressContext a1;
zone ZONE1;
}
globalTrunkGroupStatus RHEL_2 {
state inService;
totalCallsAvailable -1;
2 100

CLI Reference Guide

System Commands
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;
}
oam
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
requestRate
responsesWithAttributes
serverStatus
spuriousResponses
timedOutRequests
totalRequests
> show status oam eventLog
typeStatus
currentFile
fileRecords
fileBytes
totalFiles
totalFileBytes
memoryRecords
memoryBytes
filesDropped
memoryDropped
nextRollover
2 101
CLI Reference Guide

System Commands
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
ipSecDecryptAlarmDuration
ipSecDecryptDiscardRate
ipSecDecryptPacketsDiscarded
mediaAlarmLevel
mediaAlarmDuration
mediaDiscardRate
mediaPacketsDiscarded
rogueMediaAlarmLevel
rogueMediaAlarmDuration
rogueMediaDiscardRate
rogueMediaPacketsDiscarded
discardRuleAlarmLevel
discardRuleAlarmDuration
discardRuleDiscardRate
discardRulePacketsDiscarded
2 102

CLI Reference Guide

System Commands
TABLE 2 24 show status oam Parameters

Parameter
Length/
Range Description
cdrServer
N/A
Configuration for external CDR servers.
status
N/A
Status of the CDR server. Options are:
failedTransfers Count of the number of failed transfers.

pendingTransfers Count the number of pending transfers.
progress Specifies that a transfer is in progress.
state Type of the event log.
successfulTransfers Count of the number of files successfully
transferred.
radius
N/A
Configuration for external Radius servers.
radiusServer
Status
N/A
Status of the Radius server. Options are:
eventLog
N/A
errorRate Specifies the percentage of requests that were retried at

least once due to a timeout.
rejectedRequests Number of requests that were not responded to by
the server and presumed to have been rejected.
requestRate Average number of requests per second to the server.
responsesWithAttributes Number of responses containing
attributes.
serverStatus Specifies the operational state of the server.
spuriousResponses Number of responses without a corresponding
request.
timedOutRequests Number of requests that resulted in a timeout.
totalRequests Number of requests made to the server.
Specifies the Event log management.

2 103
CLI Reference Guide

System Commands
TABLE 2 24 show status oam Parameters (Continued)

Parameter
Length/
Range Description
typeStatus
N/A
Event log status table for status items related to each Event Log type.
currentFile Filename that is currently being used for logging.
fileBytes 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 Time of the last event record dropped when writing to
an Event Log file.
lastMemoryDrop Time of the last event record dropped when writing to
an Event Log memory buffer.
logDestination Identifies location where this Event Log type is
written.
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 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
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 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 104

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
alarms
N/A
Alarm configuration and status details. Options are:

ipPolicingAlarmStatus System policer alarm status table.
aclAlarmDuration Number of seconds the system access control
list policer alarm has been at this level.
aclAlarmLevel System access control list policer alarm level.
aclDiscardRate Current rate of access control list discards for the
system.
aclPacketsAccepted Total number of packets accepted by access
control list policers on the system.
aclPacketsDiscarded Total number of packets discarded by
access control list policers on the system.
aggregateAlarmDuration Number of seconds the system
aggregate policer alarm has been at this level.
aggregateAlarmLevel System aggregate policer alarm level.
aggregateDiscardRate Current rate of aggregate discards for the
system.
aggregatePacketsAccepted Total number of packets accepted by
aggregate policers on the system.
aggregatePacketsDiscarded Total number of packets discarded
by aggregate policers on the system.
arpAlarmDuration Number of seconds the system ARP policer
alarm has been at this level.
arpAlarmLevel System ARP policer alarm level.
arpDiscardRate Current rate of ARP discards for the system.
arpPacketsAccepted Total number of ARP packets accepted on
the system.
arpPacketsDiscarded Total number of packets discarded by ARP
policers on the system.
badEthernetIpHeaderAlarmDuration Number of seconds the
system bad Ethernet/IP Header policer alarm has been at this level.
badEthernetIpHeaderAlarmLevel System bad Ethernet/IP
Header policer alarm level.
badEthernetIpHeaderDiscardRate Current rate of bad Ethernet/
IP Header discards for the system.
badEthernetIpHeaderPacketsDiscarded Total number of
packets discarded by bad Ethernet/IP Header policers on the system.
discardRuleAlarmDuration Number of seconds the system
discard rule discard alarm has been at this level.
discardRuleAlarmLevel System alarm level discard rule.
discardRuleDiscardRate Current rate of discard rule discards for
the system.
discardRulePacketsDiscarded Total number of packets
discarded by discard rule on the system.

2 105
CLI Reference Guide

System Commands

Parameter
alarms
(continued)
Length/
Range Description
N/A
ipSecDecryptAlarmDuration Number of seconds the system

IPSEC decrypt policer alarm has been at this level.
ipSecDecryptAlarmLevel System IPSEC decrypt policer alarm
level.
ipSecDecryptDiscardRate Current rate of IPSEC decrypt
discards for the system.
ipSecDecryptPacketsDiscarded Total number of packets
discarded by IPSEC decrypt policers on the system.
mediaAlarmDuration Number of seconds the system media policer
alarm has been at this level.
mediaAlarmLevel System media policer alarm level.
mediaDiscardRate Current rate of media discards for the system.
mediaPacketsDiscarded Total number of packets discarded by
media policers on the system.
rogueMediaAlarmDuration Number of seconds the system rogue
media policer alarm has been at this level.
rogueMediaAlarmLevel System rogue media policer alarm level.
rogueMediaDiscardRate Current rate of rogue media discards for
the system.
rogueMediaPacketsDiscarded Total number of packets
discarded by rogue media policers on the system.
uFlowAlarmDuration Number of seconds the system microflow
policer alarm has been at this level.
uFlowAlarmLevel System micro flow policer alarm level.
uFlowDiscardRate Current rate of micro flow discards for the
system.
uFlowPacketsAccepted Total number of packets accepted by
micro flow policers on the system.
uFlowPacketsDiscarded 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
2 106
currentFile
1000006.SEC;
fileRecords
6;
fileBytes
986;
totalFiles
31;

CLI Reference Guide

System Commands
totalFileBytes 10955;
memoryRecords
0;
memoryBytes
0;
filesDropped
0;
memoryDropped
0;
nextRollover
0;
logDestination localDisk;
lastFileDrop
0000-00-00T00:00:00Z;
lastMemoryDrop 0000-00-00T00:00:00Z;
system
CLI syntax to display status of system objects:
> show status system
announcements
memoryUsage
cachedSegments
totalCacheMemory
totalPlayoutTime
totalSegments
usedCacheMemory
utilizedCacheMemory
segmentStatus <segmentId #>
baseMacAddress
activeBaseAddress <hexList>
assignedBaseAddress <hexList>
curentbaseAddress <hexList>
coredumpList
coredumpSummary
coredumpAndTraceCount <#>
totalSize <size>
cpuUtilCurrentStatistics
average <counter>
high <counter>
low <counter>
cpuUtilIntervalStatistics <seq. #>
average <counter>
high <counter>
intervalValid <false|true>

2 107
CLI Reference Guide

System Commands
low <counter>
time <0-4294967295>
daughterBoardStatus
partNum <part_number>
present <false|true>
productName <name>
serialNum <serial #>
dspRes
dspCallCurrentStatistics <system_name>
numCallFailNoAmr
numCallFailNoAmrwb
numCallFailNoEfr
numCallFailNoEvrc
numCallFailNoEvrcb0
numCallFailNoG711Packet
numCallFailNoG722
numCallFailNoG723
numCallFailNoG726
numCallFailNoG729
numCallFailNoG7221
numCallFailNoIlbc
numCallFailNoTone
numCallFailOtherOnAmr
numCallFailOtherOnAmrwb
numCallFailOtherOnEfr
numCallFailOtherOnEvrc
numCallFailOtherOnEvrcb0
numCallFailOtherOnG711Packet
numCallFailOtherOnG722
numCallFailOtherOnIlbc
numCallFailOtherOnTone
numCallSuccessNoAmr
numCallSuccessNoAmrwb
numCallSuccessNoDspAllocFailure
numCallSuccessNoEfr
numCallSuccessNoEvrc
numCallSuccessNoEvrcb0
numCallSuccessNoG711Packet
2 108

CLI Reference Guide

System Commands
numCallSuccessNoG722
numCallSuccessNoIlbc
numCallSuccessNoTone
numCallSuccessWithDspAlloc1Failure
dspCallIntervalStatistics <seq. #>
intervalValid
numCallFailNoAmr
numCallFailNoAmrwb
numCallFailNoEfr
numCallFailNoEvrc
numCallFailNoEvrcb0
numCallFailNoG722
numCallFailNoG723
numCallFailNoG726
numCallFailNoG729
numCallFailNoG7221
numCallFailNoIlbc
numCallFailNoTone
numCallSuccessNoAmr
numCallSuccessNoEfr
2 109
CLI Reference Guide

System Commands
numCallSuccessWithDspAllocFailure
time
dspUsageCurrentStatistics <system_name>
G711PacketAverageAvailCount
G711PacketAverageUsedCount
G711PacketPeakUsedCount
G711SSPacketAverageAvailCount
G711SSPacketAverageUsedCount
G711SSPacketPeakUsedCount
G722AverageAvailCount
G722AverageUsedCount
G722PeakUsedCount
G723PeakUsedCount
G726PeakUsedCount
G729PeakUsedCount
G7221PeakUsedCount
ToneAverageAvailCount
ToneAverageUsedCount
TonePeakUsedCount
amrAverageAvailCount
amrAverageUsedCount
amrPeakUsedCount
amrwbAverageAvailCount
amrwbAverageUsedCount
amrwbPeakUsedCount
efrAverageAvailCount
efrAverageUsedCount
efrPeakUsedCount
2 110

CLI Reference Guide

System Commands
evrcAverageAvailCount
evrcAverageUsedCount
evrcPeakUsedCount
evrcb0AverageAvailCount
evrcb0AverageUsedCount
evrcb0PeakUsedCount
ilbcAverageAvailCount
ilbcAverageUsedCount
ilbcPeakUsedCount
dspUsageIntervalStatistics <seq. #>
G722PeakUsedCount
G723PeakUsedCount
G726PeakUsedCount
G729PeakUsedCount
G7221PeakUsedCount
TonePeakUsedCount
amrAverageUsedCount
amrPeakUsedCount
amrwbPeakUsedCount
efrAverageUsedCount
efrPeakUsedCount
2 111
CLI Reference Guide

System Commands
evrcPeakUsedCount
evrcb0PeakUsedCount
ilbcPeakUsedCount
intervalValid
time
dspStatus dspUsage <system_name>
amrNbTotal
amrNbUtilization
amrWbTotal
amrWbUtilization
compressionAllocFailures
compressionAvailable
compressionTotal
compressionUtilization
ecmTotal
ecmUtilization
efrTotal
efrUtilization
evrc0Total
evrc0Utilization
evrcb0Total
evrcb0Utilization
g711SsTotal
g711SsUtilization
g711Total
g711Utilization
g722Total
g722Utilization
g726Total
g726Utilization
g729AbTotal
g729AbUtilization
g7221Total
2 112

CLI Reference Guide

System Commands
g7221Utilization
g7231Total
g7231Utilization
ilbcTotal
ilbcUtilization
toneAllocFailures
toneAvailable
toneTotal
toneUtilization
ethernetPort
mgmtPortStatus <system_name>
ifIndex
linkState
macAddress
rxDropped
rxErrors
rxPackets
txDropped
txErrors
txPackets
mgmtStatistics <mgt0|mgt1>
rxDropped
rxErrors
rxPackets
txDropped
txErrors
txPackets
packetPortStatus <server_name>
ifIndex
linkState
macAddress
negotiatedSpeed
packetStatistics
rxDropped
rxErrors
rxPackets
txDropped
txErrors
txPackets
fanStatus <system_name>
hardDiskStatus <system_name>
2 113
CLI Reference Guide

System Commands
capacity
diskLifeRemaining
diskStatus
healthTest
present
productId
revision
hardDiskUsage <system_name>
freeDiskSpace
role
syncCompletion
syncStatus
totalDiskSpace
usedDiskSpace
highAvailabilityPort
statistics
status
ipPolicing
aclOffendersList
arpOffendersList
displaylevel
mediaOffendersList
systemCurStats
systemIntStats
uFlowOffendersList
jsrcServer
serverStatus
ledStatus
licenseInfo
licenseStatus
logicalMgmtIpInterfaceStatus
mediaProfile
memoryUtilCurrentStatistics
2 114

CLI Reference Guide

System Commands
memoryUtilIntervalStatistics
ntp
peerStatus
refTime
state
stratum
systemStatus
clock
refTime
policyServer
powerSupplyStatus
savedConfigList
security
serverSoftwareUpgradeStatus
serverStatus
softwareUpgradeStatus
syncStatus
systemCongestionCurrentStatistics
systemCongestionIntervalStatistics
systemCongestionStatus
Command Parameters
TABLE 2 25 show status system Parameters
Parameter
Length/
Range Description
announcements
N/A
Announcement file status and statistics.
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.

2 115
CLI Reference Guide

System Commands
TABLE 2 25 show status system Parameters (Continued)

Parameter
Length/
Range Description
certStatistics
N/A
Displays the statistics of the certificate.
badPeerCertificates Number of bad or malformed

peer certificates presented for validation.
caCerts Number of installed CA or remote certificates.
localCerts Number of installed local certificates.
validationFailures Number of failed certificate
validations.
validationSuccess Number of successful certificate
validations.
coredumpList
N/A
List of server coredumps.
coredumpSummary
N/A
Summary of coredump files on server.
cpuUtilCurrentstatisti N/A
cs
CPU utilization for current interval period.
cpuUtilIntervalStatist N/A
ics
CPU utilization for n number of intervals.
daughterBoardStatus
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.
dspRes
2 116
N/A
DSP historical interval statistics.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
dspStatus
N/A
Status of the DSP resources. Options are:

dspUsage Current DSP resource usage. Options are:
amrNbTotal Total number of AMR-NB resources
available on this server.
amrNbUtilization Specifies the percentage utilization
of AMR-NB resources on this server.
amrWbTotal Total number of AMR-WB resources
amrWbUtilization Specifies the percentage utilization
of AMR-WB resources on this server.
compressionAllocFailures Specifies the percentage
of compression resources allocation failures on this server.
compressionAvailable Number of compression
resources currently unused and available on this server.
compressionTotal Total number of compression
resources available on this server.
compressionUtilization Specifies the percentage
utilization of compression resources on this server.
ecmTotal Total number of T.38 ECM resources available
on this server.
ecmUtilization Specifies the percentage utilization of
T.38 ECM resources on this server.
efrTotal Total EFR resource capacity on this server.
efrUtilization Percentage utilization of EFR
resources on this server.
evrc0Total Total number of EVRC0 resources
evrc0Utilization Specifies the percentage
utilization of EVRC0 resources on this server.
evrcb0Total Total number of EVRCB0 resources
evrcb0Utilization Specifies the percentage
utilization of EVRCB0 resources on this server.
g711SsTotal Total number of G.711SS (Silence
Suppression) resources available on this server.
g711SsUtilization Specifies the percentage
utilization of G.711SS (Silence Suppression) resources on
this server.
g711Total Total number of G.711 resources available
on this server.
g711Utilization Specifies the percentage utilization
of G.711 resources on this server.
on this server.

2 117
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
dspStatus (continued)
N/A

on this server.
g729AbTotal Total number of G.729A+B resources
g729AbUtilization Specifies the percentage
utilization of G.729A+B resources on this server.
g7221Total Total number of G.722.1 resources
of G.722.1 resources on this server.
g7231Total Total number of G.723.1 resources
of G.723.1 resources on this server.
ilbcTotal Total number of iLBC resources available on
this server.
ilbcUtilization Specifies the percentage utilization
of iLBC resources on this server.
toneAllocFailures Specifies the percentage of Tone
resource allocation failures on this server.
toneAvailable Number of tone resources currently
unused and available on this server.
toneTotal Total number of Tone resources available on
this server.
toneUtilization Specifies the percentage utilization
of Tone resources on this server.
ethernetPort
N/A
Management, packet and field-service ethernet port status.
fanStatus
N/A
Use this parameter to view current SBC fan speeds.

To view a specific server and fan, specify the server name and
FAN ID/TACH ID:
<server_name> Enter server name.
<FAN_ID/TACH_ID> Select a fan name:
FAN_CTR/TACH_F
FAN_CTR/TACH_R
FAN_LFT/TACH_F
FAN_LFT/TACH_R
FAN_RGT/TACH_F
FAN_RGT/TACH_R
2 118

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
hardDiskStatus
N/A
Specifies the hard disk status on the server(s). Options are:

capacity Capacity of the disk.
diskLifeRemaining A calculated percentage estimating
the life remaining of the device, or N/A if not supported by
the device.
diskStatus Specifies the hard disk status whether the
disk is online or failed:
failed|missing|online|unknown
healthTest Overall health of the device:
PASSED
FAILED
present Indicates if the hard disk exists.
false
true
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.
NOTE: If the health test fails or life remaining threshold is
reached, the drive may be faulty. Run diagnostics and
replace the drive, if needed.
hardDiskUsage
N/A
The hard disk status on the server(s). Options are:

freeDiskSpace Indicates free hard disk space (KBytes).
role Role of the server for the indicated partition.
primary
secondary.
syncCompletion Completion percentage of the partition
synchronization.
syncStatus Specifies the partition synchronization status
with peer server:
synchronized|synchronizingDestination|
synchronizingSource|unknown|unprotected
totalDiskSpace Capacity of the disk (KBytes).
usedDiskSpace Specifies the used hard disk percentage.
N/A
HA Ethernet port configurations and status.

2 119
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
ipPolicing
N/A
Specifies the MIB module for IP Monitoring. Options are:

aclOffendersList Table of statistics for the access
control list policer offenders list.
aggregateOffendersList Table of statistics for the
aggregate policer offenders list.
arpOffendersList Table of statistics for the ARP policer
offenders list.
badEthernetHdrOffendersList Table of statistics for
the bad Ethernet/IP Header policer offenders list.
discardRuleOffendersList Table of statistics for the
discard rule offenders list.
ipSecDecryptdiscardRuleOffendersList Table of
statistics for the IPSEC Decrypt policer offenders list.
mediaOffendersList Table of statistics for the media
policer offenders list.
rougeMediaOffendersList 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 Table of statistics for the micro
flow policer offenders list.
jsrcServer
N/A
Juniper Session and Resource Controller (JSRC) server

configuration.
serverStatus View JSRC server status.
ledStatus
N/A
Displays status of various server LEDs.
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.
licenseStatus
N/A
The CE license status table describes the state of license

information. Option is:
ceMode Current CE license state.
logicalMgmtIpInterface N/A
Status
mediaProfile
N/A
Status of logical IP interface.

DSP Media Profile configuration
memoryUtilCurrentStati N/A
stics
Memory utilization for current interval period.
memoryUtilIntervalStat N/A
istics
Memory utilization for n number of intervals.
2 120

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
The status of the IP interfaces in this IP interface group.

mgmtGroup Name of management IP interface group.
mgmtIpInterfaceStatus Status of IP interfaces in
the IP interface group.
ifindex Interface index of MGMT LIF.
operStatus Management interface status.
rxPackets Number of packets received on MGMT
LIF.
txPackets Number of packets sent on MGMT LIF.
N/A
ntp
NTP services management.

peerStatus Status information about each NTP peer.
refTime Time this system was last updated.
state Identifies the state of the NTP peer.
stratum Identifies the NTP peer's stratum level, or
distance from the reference clock (stratum 16 is
considered not synchronized, thus invalid).
systemStatus This table contains system status
information about NTP.
clock Current local time from the local NTP deamon on
the SBC. The display only gets periodic updates.
refTime The timestamp inside the packet received from
the external NTP server.
policyServer
N/A
Policy server configuration.

policyServerStatus
powerSupplyStatus
N/A
Power consumption or state of the server.

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.
savedConfigList
N/A
List of configurations saved on system.
security
N/A
MIB module for security management.
serverSoftwareUpgradeS N/A
tatus
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 121
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
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).
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.
2 122

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
N/A
Specifies the live software upgrade status at any given time.

activeCeAtStart 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 Software release to which the upgrade is
performed.
oldRelease Software release that was running before
upgrade started.
package Name of the new package.
previousState Specifies the previous LSWU state.
primaryUpgradeStatus Current status of the primary
server.
reason Exit reason for failure of the last software upgrade.
revertScript Script to run to perform revert in case
upgrade fails.
revertStartTime Indicates when the live software
upgrade started.
rpmName Name of the new RPM used for upgrade.
secondaryUpgradeStatus -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.
syncStatus
N/A
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.

2 123
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
systemCongestionCurren N/A
tStatistics
The Sonus System Congestion Current Statistics table. Options

are:
2 124
avgCallRate Current system average call arrival rate.

avgRegRate Current average SIP registration arrival rate.
callArrivals Current number of call arrivals.
emergencyCallArrivals Current number of SIP
emergency calls arrived.
emergencyCallRejects Current number of SIP
emergency calls rejected.
levelMC1Count Current number of transitions into MC1.
levelMC1TotalTime Current sum of time spent in MC1.
overloadRejects Current number of calls rejected due
to System congestion.
peakCallRate Current system peak call arrival rate.
peakRegRate Current peak SIP registration arrival rate.
sipRegArrivals Current number of SIP registrations
arrived.
sipRegRejects Current number of SIP registrations
rejected.

CLI Reference Guide

System Commands

Parameter
Length/
Range Description
systemCongestionInterv N/A
alStatistics
The Sonus System Congestion Interval Statistics table.
avgCallRate Current system average call arrival rate.

avgRegRate Current average SIP registration arrival rate.
callArrivals Current number of call arrivals.
emergencyCallArrivals Current number of SIP
emergency calls arrived.
emergencyCallRejects Current number of SIP
emergency calls rejected.
true
false
overloadRejects Current number of calls rejected due
to System congestion.
peakCallRate Current system peak call arrival rate.
peakRegRate Current peak SIP registration arrival rate.
sipRegArrivals Current number of SIP registrations
arrived.
sipRegRejects Current number of SIP registrations
rejected.
time System up time when the interval statistics is
collected.

2 125
CLI Reference Guide

System Commands

Parameter
Length/
Range Description
systemCongestionStatus N/A
System congestion status. Options are:

systemCongestionCPULevel Specifies the CPU
congestion level.
systemCongestionCallAcceptCount Current number
of calls being accepted by the system measured in calls per
second.
systemCongestionCallAcceptRate Current rate at
which calls are being accepted by the system.
systemCongestionCallArrivalRate Current system
call arrival rate.
systemCongestionCallEqArrivalRate Current
system call equivalence real call and registration arrival rate
systemCongestionCallRateLevel Call rate
congestion level.
systemCongestionMCDuration Number of seconds the
system has been at this congestion level.
systemCongestionMCLevel Specifies the System
congestion level.
systemCongestionMemLevel Specifies the Memory
congestion level.
systemCongestionRegArrivalRate Current system
SIP registration arrival rate
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 ERE server PSX_LOCAL_SERVER:
admin@server1> show status system policyServer
policyServerStatus ipAddress 127.0.0.1
policyServerStatus PSX_LOCAL_SERVER {
2 126
index
0;
operState
Active;
CLI Reference Guide

System Commands
ipAddress
127.0.0.1;
averageTransactionTime
0;
serverReconnects
0;
transactionCompleted
2;
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:
admin@server1> show status system dspRes
dspCallCurrentStatistics
dspCallCurrentStatistics sbx10 {
numCallFailNoAmrwb
0;
numCallFailNoAmrwb
0;
numCallFailNoEfr
0;
numCallFailNoEvrc
0;
numCallFailNoEvrcb0
0;
0;
numCallFailNoG722
0;
numCallFailNoG723
0;
numCallFailNoG726
0;
numCallFailNoG729
0;
numCallFailNoG7220
0;
numCallFailNoIlbc
0;
numCallFailNoTone
0;
0;
0;
0;
0;
0;
0;

2 127
CLI Reference Guide

System Commands
0;
0;
0;
0;
0;
0;
0;
numCallSuccessNoAmr
0;
0;
0;
numCallSuccessNoEfr
0;
0;
0;
0;
0;
0;
0;
0;
0;
0;
0;
numCallSuccessWithDspAllocFailure 0;
}
To view the call interval statistics of the DSP Resource pad:
dspCallIntervalStatistics
dspCallIntervalStatistics 2 sbx10 {
intervalValid
true;
time
2549;
0;
numCallSuccessWithDspAllocFailure 0;
2 128
numCallFailNoG729
0;
0;
0;
numCallFailNoG726
0;
0;
0;
0;

CLI Reference Guide

System Commands
0;
0;
numCallFailNoG723
0;
0;
0;
numCallFailNoIlbc
0;
0;
0;
numCallFailNoEvrcb0
0;
0;
0;
numCallFailNoGsm
0;
numCallFailOtherOnGsm
0;
numCallSuccessNoGsm
0;
numCallFailNoAmrwb
0;
0;
0;
numCallFailNoG722
0;
0;
0;
numCallFailNoTone
0;
0;
0;
numCallFailNoEvrc
0;
0;
0;
numCallFailNoG7221
0;
0;
0;
numCallFailNoEfr
0;
0;
numCallSuccessNoEfr
0;
}
To view the DSP current usage statistics of the DSP Resource pad:
dspUsageCurrentStatistics
dspUsageCurrentStatistics sbx10 {

2 129
CLI Reference Guide

System Commands
0;
amrAverageUsedCount
0;
amrPeakUsedCount
0;
0;
0;
amrwbPeakUsedCount
0;
0;
efrAverageUsedCount
0;
efrPeakUsedCount
0;
0;
0;
0;
0;
evrcb0PeakUsedCount
0;
evrcPeakUsedCount
0;
0;
0;
0;
0;
0;
0;
0;
G7221PeakUsedCount
0;
0;
0;
G722PeakUsedCount
0;
11;
0;
G723PeakUsedCount
0;
11;
0;
G726PeakUsedCount
0;
11;
0;
G729PeakUsedCount
0;
2 130
11;
11;
0;
CLI Reference Guide

System Commands
ilbcPeakUsedCount
0;
0;
0;
TonePeakUsedCount
0;
}
To view the DSP usage interval statistics of the DSP Resource pad:
dspUsageIntervalStatistics
dspUsageIntervalStatistics <system_name> {
intervalValid
true;
time
3449;
0;
amrAverageUsedCount
0;
amrPeakUsedCount
0;
0;
0;
amrwbPeakUsedCount
0;
0;
efrAverageUsedCount
0;
efrPeakUsedCount
0;
0;
0;
0;
0;
evrcb0PeakUsedCount
0;
evrcPeakUsedCount
0;
11;
0;
0;
0;
0;
0;
0;
0;
G7221PeakUsedCount
0;
0;
0;
G722PeakUsedCount
0;

2 131
CLI Reference Guide

System Commands
11;
0;
G723PeakUsedCount
0;
11;
0;
G726PeakUsedCount
0;
11;
0;
G729PeakUsedCount
0;
11;
0;
ilbcPeakUsedCount
0;
0;
0;
TonePeakUsedCount
0;
}
To view the status of the DSP Resource pad:
admin@server1> show status system dspStatus
dspUsage sbx10 {
compressionTotal
10272;
compressionAvailable
10272;
compressionUtilization
0;
compressionAllocFailures 0;
2 132
g711Total
10272;
g711Utilization
0;
g711SsTotal
8544;
g711SsUtilization
0;
g726Total
5760;
g726Utilization
0;
g7231Total
5760;
g7231Utilization
0;
g722Total
0;
g722Utilization
0;
g7221Total
0;
g7221Utilization
0;
g729AbTotal
5184;
g729AbUtilization
0;
ecmTotal
4800;
CLI Reference Guide

System Commands
ecmUtilization
0;
ilbcTotal
3648;
ilbcUtilization
0;
amrNbTotal
0;
amrNbUtilization
0;
amrWbTotal
0;
amrWbUtilization
0;
evrcb0Total
0;
evrcb0Utilization
0;
evrc0Total
0;
evrc0Utilization
0;
toneTotal
0;
toneAvailable
0;
toneUtilization
0;
toneAllocFailures
0;
efrTotal
0;
efrUtilization
0;
show table
The show table command displays the current configuration and status of the
following SBC 5x00 objects in table format.

"alarms" on page 2 138
"oam" on page 2 140
"profiles" on page 2 143
addressContext
The command syntax of the objects related to the show table
addressContext command is shown below.
> show table addressContext <addressContext_name>
cacOffenderStatus
diamNode
dnsGroup
dynamicBlackList
dblPolicerStatus
2 133
CLI Reference Guide

System Commands
dblStatus
ipAccessControlList
defaultAclStatistics <rule id>
addressContextId
application
bucketSize
creditRate
destinationIpAddress
lifGrpId
packetAccept
packetDiscard
polId
polPriority
policingMode
protocol
sourceIpAddress
matchedNoRule
ipAclRuleStatistics
rule
ipInterfaceGroup <group_name>
ipInterface
action <druUp|force>
altIpAddress
altPrefix
bandwidth
bwContingency
ceName
dryupTimeout
ipAddress
mode <inService|outOfService>
portName
prefix
vlanTag
ipInterfaceStatus
actualBandwidth
allocatedBandwidth
bwDeviation
ifindex
2 134

CLI Reference Guide

System Commands
numCalls
oosReason <admin|linkDown|notApplicable|portDown|
serverDown|standby>
operState <admnDisabled|admnEnabled|deallocDryup|
deallocForce1|deallocForce2|null|remoteCreated|
remoteCreating|resAllocated|resAllocating>
rxPackets
txPackets
ipRouteStatus <system_name>
protocol <bbnSpfIgp|bgp|ciscoEigrp|ciscoIgrp|egp|esIs|
ggp|hello|icmp|idpr|isIs|local|netmgmt|ospf|other|rip>
ipsec
ikeSaStatistics
ikeSaStatus
ipsecSaStatistics
ipsecSaStatus
peer
spd
systemStatistics
linkDetectionGroup
logicalSigAddressBindingStatus
natDirectMediaGroup
rtpServerTable
aorName
contactURI
creationTime
extExpirationTime
intExpirationTime
nextHopIpAddress
nextHopPortNum
regIdIsChild
registrarDomainName
registrarIpAddress
registrarPortNum
state <challenged|completed|deleting|expired|
initiating|null|refreshing|terminated|updating>
2 135
CLI Reference Guide

System Commands
sipActiveGroupRegSummaryStatus <SIP Registrars IP

address>
aorName
nextRegIdIsChild
sipActiveRegisterNameStatus
contactURI
creationTime
endPointBehindNapt
externalExpirationTime
internalExpirationTime
natPinholeLearningStatus
nextHopIpAddress
nextHopPortNum
registrarDomainName
registrarIpAddress
registrarPortNum
securityMechanismType
sipDeletedRegStatus
sipDeletedRegisterNameStatus
sipRegCountAttempts
sipRegCountCumCompletions
sipRegCountPending
sipRegCountStable
sipRegCountTotal
sipSubCountAttempts
sipSubCountCumCompletions
sipSubCountStable
sipSubCountTotal
staticRoute <dest. IP address>
preference
surrRegActiveRegCount
2 136

CLI Reference Guide

System Commands
surrRegConfiguredCount
zone (zone parameters are listed following this listing)
egressFailBWLimit
egressFailCallLimit
egressFailCallPolicing
egressSipRegFailLimit
egressSipRegPolicing
ingressFailBWLimit
ingressFailCallLimit
ingressFailCallPolicing
ingressSipRegFailLimit
ingressSipRegPolicing
(same params as zoneCurrentStatistics)
intervalValid <false|true>
time
zoneStatus
activeSipRegCount
bwAvailable
bwCurrentLimit
bwInboundUsage
bwOutboundUsage
emergencyCallsBwUsage
inboundCallsUsage
outboundCallsUsage
priorityCallUsage
totalCallsAvailable
totalCallsConfigured
The command syntax of the objects related to the show table
addressContext <addressContext_name> zone <zone_name>
command is shown below.
cac
dnsGroup
gwSigPort
2 137
CLI Reference Guide

System Commands
gwSigPortStatistics
gwSigPortStatus
gwTrunkGroup
h323SigPort
h323SigPortStatus
h323TrunkGroup
id
ipPeer
messageManipulation
peerPathchkStatus
peerQosStatus
peerSurrRegStatus
remoteDeviceType
sipArsStatus
sipOcsCallCurrentStatistics
sipOcsCallIntervalStatistics
sipPeerCacStatus
sipSigConnStatus
sipSigPort
sipSigPortStatus
sipTrunkGroup
trafficControlCurrentStatistics
trunkGroupQoeStatus
trunkGroupStatus
alarms
The command syntax of the objects related to the show table alarms
command is shown below (see show status alarms for parameter details).
2 138

CLI Reference Guide

System Commands
> show table alarms

currentStatus
historyStatus
global
The command syntax of the objects related to the show table global
> show table global
cac
callCountStatus
callDetailStatus
callMediaStatus
callResourceDetailStatus
callRouting
callSummaryStatus
callTrace
carrier
country
globalTrunkGroupStatus
icmpGeneralGroupStatistics
ipGeneralGroupStatistics
license
monitorEndpoint
monitorEndpointStatus
monitorTarget
monitorTargetStatus
npaNxx
ocsCallCountStatus
policyServer
qoeCallRouting
script
security
servers
signaling
sipDomain
subscriber
tcpGeneralGroupStatistics
udpGeneralGroupStatistics
2 139
CLI Reference Guide

System Commands
oam
The command syntax of the objects related to the show table oam command
is shown below.
> show table oam
accounting
admin
earlyAttemptState
generationMode
intermediateAcctInterval
intermediateAcctMode
intermediateAcctState
intermediateLongDurGenTime
intermediateLongDurThreshold
intermediateTrapState
maxRecordSequenceNum
populateIpTgFarEndSwitchType
populateNonPortedLnpNumbers
populateRemoteGsxInfoState
secondStageInheritFirstStage
sendEgressCdrInfoOnReceipt
startAcctState
cdrServer
admin
connectionTimeout
filePrefix
ipAddress
password
path
transferTimeout
username
status <primary or secondary>
failedTransfers
pendingTransfers
progress <connecting|done|failed|idle|started|
transferring>
state <active|standby>
successfulTransfers
radius
accountingAdmin
failoverPolicy
maxErrorRate
2 140

CLI Reference Guide

System Commands
maxNoResponseTime
maxPacketRetryCount
maxQueuedPacketsInMemory
nasIdentifier
nasIpAddress
sendNasIdentifier
sendNasIpAddress
state
radiusServer
radiusServerStatus
alarms
ipPolicingAlarmAdmin
majorAlarmMode
majorAlarmProfileName
minorAlarmMode
minorAlarmProfileName
ipPolicingAlarmStatus
aclAlarmDuration
aclAlarmLevel
aclDiscardRate
aclPacketsAccepted
aclPacketsDiscarded
aggregateAlarmDuration
aggregateAlarmLevel
aggregateDiscardRate
aggregatePacketsAccepted
aggregatePacketsDiscarded
arpAlarmDuration
arpAlarmLevel
arpDiscardRate
arpPacketsAccepted
arpPacketsDiscarded
badEthernetIpHeaderAlarmDuration
badEthernetIpHeaderAlarmLevel
badEthernetIpHeaderDiscardRate
badEthernetIpHeaderPacketsDiscarded
discardRuleAlarmDuration
discardRuleAlarmLevel
discardRuleDiscardRate
discardRulePacketsDiscarded
ipSecDecryptAlarmDuration
ipSecDecryptAlarmLevel

2 141
CLI Reference Guide

System Commands
ipSecDecryptDiscardRate
ipSecDecryptPacketsDiscarded
mediaAlarmDuration
mediaAlarmLevel
mediaDiscardRate
mediaPacketsDiscarded
rogueMediaAlarmDuration
rogueMediaAlarmLevel
rogueMediaDiscardRate
rogueMediaPacketsDiscarded
uFlowAlarmDuration
uFlowAlarmLevel
eventLog
confdDebugLevel
filterAdmin
filterStatus
subsystemAdmin
typeAdmin
typeStatus
localAuth user
group <Administrator|Calea|FieldService|Guest|
Operator>
radiusNasIp
radiusServerIp
radiusServerPort
radiusSharedSecret
snmp
community engineId
trapTarget
ipAddress
port
trapType <inform|v1|v2>
traps
admin <traps>
dspAdmin
callFailureTrap lackdsp
interval
threshold
2 142

CLI Reference Guide

System Commands
dspAvailabilityTrap
allThreshold
g711PacketThreshold
g726Threshold
g729Threshold
profiles
NOTE
When using the show command to view particular profile attributes,

be sure to include the profile name in the command to avoid syntax
errors.
Example to view egressIpAttributes:
> show table profiles signaling ipSignalingProfile
DEFAULT_SIP egressIpAttributes
The command syntax of the objects related to the show table profiles
> show table profiles
callParameterFilterProfile
SIP_MSG_TYPE_INFO
SIP_MSG_TYPE_MESSAGE
SIP_MSG_TYPE_NOTIFY
SIP_MSG_TYPE_REGISTER
SIP_MSG_TYPE_SUBSCRIBE
none
callRouting
crankbackProfile
attemptRecordGeneration
lateCrankback
reason
elementRoutingPriority entry
<_private|carrierCutThrough|internationalOperator|
internationalType|ipVpnService|localOperator|
longDistanceOperator|mobile|nationalOperator|
nationalType|otherCarrierChosen|test|transit|
userName>
holiday
timeRangeProfile
entry
dayMatching
2 143
CLI Reference Guide

System Commands
timeMatching
timeZone
dmPmCriteria
<criteria name>
criteriaType <digit|parameter|uri>
digitCriteria <digitMatch|egressFlag|
natureOfAddress|numberLength|n
umberingPlanIndicator|presentationMatch|
screeningMatch>
digitType <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|gnUserCallingScreened|
location|originalCalledNumber|outpulseNumber|
presentationNumber|pretranslated|redirecting|
redirection|twoStageCollected>
parameterCriteria
<additionalCategory|callingName|carrierCode|
carrierSelectionParameter|causeOfNoId|
characterMatch|cliBlockingIndicator|cpc|
dpcIndicator|forwardCallIndicator|
fromDisplayName|jurisdictionSwitch|olip|
paiCharacterMatch|paiSipDisplayName|
paiTelDisplayName|prefixType|zzCode>
parameterPresenceCheck <dowsntExist|exists>
parameterType
<additionalCategory|calledPrefix|callingName|
callingPrefix|carrierCode|carrierSelectionParame
ter|causeOfNoId|cliBlockingIndicator|cpc|
dpcIndicator|forwardCallIndicator|
fromDisplayName|jurisdictionSwitch|olip|
originatingCarrier|originatingChargeArea|paiSipD
isplayName|paiTelDisplayName|transitNetworkSelec
tion|zzCode>
uriCriteria
host
presentationMatch
userInfo
operation <equals|ignore|notEquals>
value
2 144

CLI Reference Guide

System Commands
matchValue
startCharacterPosition
validateUserInfoDigits <equals|ignore|
notEquals>
uriType <calledUri|callingUri|fromUri|paiSipUri|
toUri>
dmPmRule <identifier>
subRule <priority>
criteria <criteria name>
digitManipulation
digitStringManipulation
numberParameterManipulation
numberType
parameterManipulation
additionalCategory
availability
callingName
carrierCode
carrierSelectionParameter
causeOfNoId
characterManipulation
cpc
flags
forwardCallIndicator
fromDisplayName
originatingCarrier
originatingChargeArea
originatingLineInformation
parameterType
presentation
zzCode
ruleType <digit|parameter|uri>
uriParameterManipulation
hostPortManipulation
uriType
userInfoManipulation
numberingPlan
lengths <areaCode|exchangeCode|line|nationalNumber|
subscriberNumber>
prefixProfile <profile>
prefixProfile <profile>
2 145
CLI Reference Guide

System Commands
digitProfile
dtmfTrigger
interdigitTimeout
longdigitDuration
pattern
featureControlProfile
processDestinationTrunkContext
media
announcementPackage
element segmentId
packageId
codecEntry <codec>
activeCodecSet
codec
codingRate
dtmf
fax
fecRedundancy
law
modeSet
modem
packetSize
preferredRtpPayloadType
sendSid
silenceSuppression
mediaQosKpiProfile
packetServiceProfile <unique identifier>
aal1PayloadSize
codec
dataCalls
flags
honorRemotePrecedence
mediaPacketCos
packetToPacketControl
peerAbsenceAction
preferredRtpPayloadTypeForDtmfRelay
rtcpOptions
secureRtpRtcp
2 146

CLI Reference Guide

System Commands
sendRoutePSPPrecedence
silenceFactor
silenceInsertionDescriptor
t38
typeOfService
videoCalls
voiceInitialPlayoutBufferDelay
localRingBackTone
flags
makeInbandToneAvailable
precedence
signalingTonePackage
signalingTonePackageState
toneAndAnnouncement
announcementPackage
announcementPackageState
override
sigTonePackage
tonePackage
packageId
toneType
toneProfile
<defBusy|defCallWaiting1|defCallWaiting2|
defCallWaiting3|defCallWaiting4|defCpeAlertin
g|defDial|defReorder|defRing|defSit1|defSit2|
defSit3|fccBusy|fccDial|fccRingback>
toneProfile <profile user name>
break1
break2
break3
compositeTone
dualTone
generationMethod
make1
make2
make3
modulatedTone
repeat
repeat1
repeat2
repeat3
singleTone
2 147
CLI Reference Guide

System Commands
security
cryptoSuiteProfile
ipsecProtectionProfile
tlsProfile
services
classOfService
dblProfile
disconnectSignalSequenceProfile
disconnectTreatmentProfile
emergencyCallProfile
pathCheckProfile
sipArsProfile
sipSecurityProfile
signaling
XHeaderProfile
ipSignalingProfile
numberGlobalizationProfile
sctpProfile
signalingProfile
sipAdaptorProfile
sipCauseCodeMapping
sipCacProfile
system
coredumpProfile
overloadProfile
system
The command syntax of the objects related to the show table system
> show table system
admin
announcements
baseMacAddress
congestion
coredumpList
2 148

CLI Reference Guide

System Commands
coredumpSummary
cpuUtilCurrentStatistics
cpuUtilIntervalStatistics
daughterBoardStatus
dspPad
dspRes
dspStatus
ethernetPort
fanStatus
hardDiskStatus
hardDiskUsage
intervalStatistics
ipPolicing
jsrcServer
ledStatus
licenseInfo
licenseStatus
logicalMgmtIpInterfaceStatus
media
mediaProfile
memoryUtilCurrentStatistics
memoryUtilIntervalStatistics
mgmtStaticRoute
ntp
policyServer
powerSupplyStatus
savedConfigList
security
serverAdmin
serverSoftwareUpgradeStatus
upgrademodule.
serverStatus
syncStatus
systemCongestionCurrentStatistics
2 149
CLI Reference Guide

System Commands
systemCongestionIntervalStatistics
systemCongestionStatus
Command Examples:
To view static route:
> show table addressContext staticRoute
INGRESS
FAIL
CALL
EGRESS
INTERVAL
NAME
NUMBER NAME
LIMIT
POLICING P
VALID
INGRESS
FAIL
FAIL
CALL
CALL
TIME
LIMIT
----------------------------------------------------------------------------default
0
44
DNS
true
40376
40376 0
0
44
defaultSigZone true
0
45
0
DNS
true
41276
0
45
defaultSigZone true
41276 0
0
46
DNS
true
42176
0
46
defaultSigZone true
42176 0
0
47
DNS
true
43076
0
47
defaultSigZone true
43076 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
ACTIVE
STABLE
TOTAL
CALLS
CALLS
TOTAL
CALLS
2 150
TOTAL CALLS
CALLS

CLI Reference Guide

System Commands
CALL
NON
KEY
CALL
TOTAL NON
ACTIVE
EMERG
STABLE CALL
EMERG
ATTEMPTS COMPLETIONS CALLS

CALLS
UPDATES
USER
CALLS USER
ESTABLISHING STABLE
NON
USER
-----------------------------------------------------------------------------------------------------all
0
0
0
0
To switch over 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
SYNC MODULE
STATUS
--------------------------------------Policy Data
syncCompleted
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 front panel LED status of the system when the LED locator is ON:
SERVER
LED
LED
LED
NAME
TYPE
STATE
COLOR
-------------------------------

2 151
CLI Reference Guide

System Commands
Hackos
Alarm
on
red
Hackos
Power
on
green
Hackos
Active
on
green
Hackos
Status
on
green
Hackos
Locator
blinking
Irving
Alarm
off
none
Irving
Power
on
green
Irving
Active
off
none
Irving
Status
on
green
Irving
Locator
blinking
white
white
To view the license information of the application:

> show table system licenseInfo
LICENSE
FEATURE NAME
ID
USAGE
EXPIRATION DATE
LIMIT
-----------------------------------------------SRTP
7422
2012-12-06-05:00
ENCRYPT
7422
2012-12-06-05:00
SBC-RTU
7422
2012-12-06-05:00
20
DSP-EVRC
7422
2012-12-06-05:00
DSP-G722
7422
2012-12-06-05:00
DSP-AMRNB
7422
2012-12-06-05:00
DSP-AMRWB
7422
2012-12-06-05:00
SBC-SIP-I
7422
2012-12-06-05:00
SBC-SIP323
7422
2012-12-06-05:00
SBC-POL-RTU
7422
2012-12-06-05:00
SBC-POL-E911
7422
2012-12-06-05:00
SBC-POL-ENUM
7422
2012-12-06-05:00
To view the call count status for the server as a table after a switchover:
> show table global callCountStatus
ACTIVE
STABLE
TOTAL
CALLS
CALLS
TOTAL
CALLS
CALL
NON
KEY
2 152
CALL
TOTAL NON
TOTAL CALLS
ACTIVE
EMERG
CALLS
STABLE CALL
EMERG
ATTEMPTS COMPLETIONS CALLS

CALLS
UPDATES
USER
CALLS USER
ESTABLISHING STABLE
NON
USER

CLI Reference Guide

System Commands
-----------------------------------------------------------------------------------all
0
0
To view the status of IP trunk groups in this zone:

> show table global globalTrunkGroupStatus
TOTAL
TOTAL
TOTAL
BW
CALLS
OUTBOUN
TOTAL
CALLS
PRIORITY OUTBOUND BW
CALL
CALLS
CALLS
INBOUND
INBOUND
CALLS
CURRENT BW
NAME
STATE
AVAILABLE RESERVED
CONFIGURED USAGE
RESERVED LIMIT
USAGE
OUTBOUND
BW
CALLS
INBOUND
USAGE
USAGE
AVAILABLE USAGE
---------------------------------------------------------------------------------------------------------------------RHEL_1
1
inService
0
-1
RHEL_2
1
inService
0
-1
0
0
0
-1
-1
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
*69 admin
cli
10.128.130.10 ssh
CONFIG MODE
11:02:09

2 153
CLI Reference Guide

System Commands
24 admin
netconf 127.0.0.1
ssh
2012-11-12
19 Guest
cli
ssh
2012-11-12
127.0.0.1
show utils
The show utils command displays the system utilities such as event log and
route table.
Command Syntax
To view the system utilities:
> show utils eventLog
act
audit
dbg
sec
sys
trc
> show utils routeTable
Example
To display the current trace event:
admin@server1> show utils eventLog trc
Sonus Networks, Inc.0000000001600000000000000000000128
V03.01.00A0350000000000000000000000000000TRC2012110814075
500000000000000
To display route table:
admin@server1> show utils routeTable
Kernel IP routing table
Destination
Gateway
Ref
Use Iface
2 154
Genmask
Flags Metric
10.6.83.0
0 mgt1
0.0.0.0
255.255.255.0
10.6.82.0
0 mgt0
0.0.0.0
255.255.255.0
10.6.81.0
0 eth0
0.0.0.0
255.255.255.0
10.7.0.0
0 pkt0
0.0.0.0
255.255.0.0
10.7.0.0
0 pkt2
0.0.0.0
255.255.0.0

CLI Reference Guide

System Commands
169.254.0.0
0 eth1
0.0.0.0
255.255.0.0
0.0.0.0
0 eth0
10.6.81.1
0.0.0.0
UG
0.0.0.0
0 mgt1
10.6.83.1
0.0.0.0
UG
10
0.0.0.0
0 mgt0
10.6.82.1
0.0.0.0
UG
10
0.0.0.0
0 mgt0
10.6.82.1
0.0.0.0
UG
100
0.0.0.0
0 mgt1
10.6.83.1
0.0.0.0
UG
200
source
The source operation is used to source a file containing CLI commands. This file
must be located in the directory /home/Administrator.
> source <file to source>
.bash_history
MyFile
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.
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 155
CLI Reference Guide

2 156
System Commands

CLI Reference Guide

Configure CLI Operations
CHAPTER 3
Overview
This chapter provides information on the operations associated with the SBC
5x00 Configure CLI mode, including command syntax, parameters and
attributes, and command examples.
To exit Configure mode, enter either quit or exit.
The CLI supports SBC 5x00 provisioning and managing of the following SBC
5x00 objects.
Example: To find the SBC 5x00 objects to come next using the set command,
enter set at the command prompt followed by a space and the ? key.
admin@Irving% set ?
addressContext - Objects scoped to a specific IP addressing
domain.
global
- Global objects that are applicable Node wide
oam
profiles - Profiles of configuration shared by multiple

objects.
system
For more information on provisioning and managing SBC 5x00 objects, refer to
the respective chapters of the SBC 5x00 Objects.
Each command details are explained in the following sub-sections.

31
CLI Reference Guide

Configure Commands
Configure Commands
The following operations are supported in both Exclusive and Private sessions:
commit Commit current set of changes

delete Delete a particular data element
edit Edit a particular sub-element
exit Exit from this level
help Provide help information
quit Exit from this level
revert Revert back to the previous configuration state
rollback Roll database back to last committed version
set Set a parameter
show Show a parameter
status View status of users currently logged into CLI
commit
When issuing commands in the Configure mode, you must perform a commit for
the changes to take effect.
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 to commit at one
time (equates to modifying approximately 100 field values). To avoid
errors, issue the commit command on a regular basis to execute small
batches of commands.
32

CLI Reference Guide

Configure Commands
delete
Use the delete command to delete a specific data element, object, profile or
configuration.
Command Syntax
% delete
addressContext Objects scoped to a specific IP addressing domain.
global Global objects applicable node-wide.
no-confirm <prompt user>
oam Operations and Maintenance objects.
profiles Profiles shared by multiple objects.
system System-level configuration.
edit
The edit command allows you to edit a particular data element, object, profile or
configuration.
exit
Use the exit operation to exit the Configure mode and revert back to System
mode.
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 8.
quit
The quit operation serves the same function as exit and takes you out of the
Configure mode and back to System mode.

33
CLI Reference Guide

Configure Commands
request
The request operation facilitates system-level requests for the following objects
from both System and Configure modes.
addressContext Objects scoped to a specific IP address domain.

alarms Alarm Management
global Global objects that are applicable Node wide
message Send message to terminal of one or all users
system System operations
The command syntax of this operation is described in detail in Chapter 2,

"System-Level CLI Operations" in the section also named "request" on page 2 5.
revert
Use the revert operation to revert back to the previous configuration state.
When prompted, enter y to proceed. To revert without receiving the confirmation
prompt, enter revert no-confirm.
Command Example
% revert
All configuration changes will be lost. Proceed? [yes,no] y
rollback
Use rollback operation to roll the database back to the last committed version.
Command Syntax
% rollback <index#>
Command Example
To view rollback options and obtain an index number, enter rollback followed
by Tab key. For example:
% rollback <Tab>
0 - 2012-08-21 17:43:57 by admin via netconf
34

CLI Reference Guide

Configure Commands
1 - 2012-08-21 15:08:19 by system via system

To rollback to the committed version dated 2012-08-21, enter:
% rollback 1
set
Use the set operation to create or modify an object. The objects associated with
this command are listed below and defined in subsequent chapters in this guide.
addressContext Objects scoped to a specific IP addressing domain. See

Chapter 4, "Address Context".
global Global objects that are applicable Node wide. See Chapter 5,
"Global".
oam Operations and Maintenance objects. See Chapter 6, "Operations and

Maintenance (OAM)".
profiles Profiles of configuration shared by multiple objects. See

Chapter 7, "Profiles".
system System-level configuration. See Chapter 8, "System".
show
The show operation displays the following objects and their attributes and is often
used with set operation (see above) to view results of provisioning activities.
addressContext Objects scoped to a specific IP addressing domain.

details Show details
displaylevel Use to define the level (1-64) of detail to show.
global Global objects that are applicable Node wide
profiles Profiles of configuration shared by multiple objects.
system System-level configuration.
status
The status command displays the status of all users currently logged into CLI.
Command Example
% status
Users currently editing the configuration:
admin ssh (cli from 10.113.130.13) on since 2012-08-22
00:54:50 private mode
35
CLI Reference Guide

Configure Commands
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.
up
The up operation is used to exit one level of configuration. In Edit mode, the up
command takes you to one level up.
36

CHAPTER 4
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 4 1 Address Context Objects
An address context helps to disambiguate overlapped addresses in Signaling

Ports and 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.
41
CLI Reference Guide

Address Context
The following objects are associated with an address context and are defined in
this chapter, including command syntax, parameters and command examples:
42
"Diameter Node" on page 4 3

"DNS Group" on page 4 7
"Intercept" on page 4 13 (available to Calea user only)
"IP Access Control List" on page 4 16
"IP Interface Group" on page 4 25
"IPsec" on page 4 32
"Link Detection Group" on page 4 41
"NAT Direct Media Group" on page 4 61
"RTP Server Table" on page 4 63
"Static Route" on page 4 64
"Zone" on page 4 67

CLI Reference Guide

Diameter Node
Address Context
Diameter Node
Use this feature to configure the Diameter Realm for external QoS requests on a
per-IP TG basis.
Command Syntax
% set addressContext <addressContext_name> diamNode
<diameterNode_name>
ipInterfaceGroupName <IPIG_name>
ipV4Address <IPv4 address towards peer>
ipV6Address <IPv6 address towards peer>
originRealm <origin realm name>
peer <peer_name>
fqdn <fqdn>
ipAddress <IP address>
tcpPort <#>
primaryOriginHost <primary host name>
realmRoute <route_name>
appId rx
peer <name>
priority <0-100>
realm <name>
secondaryOriginHost <secondary host name>
transactionTimeout <500-6000 milliseconds>

43
CLI Reference Guide

Address Context
Diameter Node
Command Parameters
TABLE 4 1
Diameter Node Parameters
Parameter
Length/
Range
Description
diamNode
1-23
Diameter node name.
N/A
The name of the IP interface group used by this Node.
ipV4Address
N/A
IPv4 address used to create connections towards peer.
ipV6Address
N/A
IPv6 address used to create connections towards peer.
originRealm
0-128
The origin realm for this node.
peer
0-32
The Diameter peers for this node. Additional arguments to

define peer are listed below:
fqdn FQDN for this peer.
ipAddress IP Address of this peer.
state Admin state of this peer.
disabled (default)
enabled
tcpPort TCP port number of this peer (default is 3868).
primaryOriginHost
0-128
The primary origin host for this node.
realmRoute
N/A
Realm route for this node. Additional realm route arguments:

appId Application ID for this route. (default is rx for
PCRF interface, and is not configurable)
peer The name of the peer this route belongs to.
priority Priority of this Route. (range 0-100 / default =
0)
realm Realm name of this route.
state Administrative state of this peer.
disabled (default)
enabled
secondaryOriginHost
0-128
The secondary origin host for this node.
state
N/A
Use this flag to set the state of this Diameter node.

disabled (default)
enabled
transactionTimeout
44
500-6000 Enter desired transaction timeout in milliseconds.

(default = 1000)

CLI Reference Guide

Diameter Node
Address Context
Command Example
Example Diameter Node configuration:
% set addressContext ADDR_CONTEXT_1 diamNode diam
ipInterfaceGroupName LIG1 ipV4Address 10.54.154.89
ipV6Address fe80::210:6bff:fe03:231 originRealm pcscfopen-ims.test primaryOriginHost katie secondaryOriginHost
eleanor transactionTimeout 1500
Mandatory parameters:
1. At least one IP address is required (ipV4Address or ipV6Address)

2. diamNode name
3. primaryOriginHost name
4. ipInterfaceGroupName
5. originRealm name
Default Values:
state = disabled
transactionTimeout = 1000 ms
Example Peer Configuration:

% set addressContext ADDR_CONTEXT_1 diamNode diam peer
camiant.nj.sonusnet.com ipAddress 1.2.3.4 fqdn
camiant.nj.sonusnet.com tcpPort 4868
1. fqdn
2. ipAddress
3. peer name
Default values:
state = disabled
tcpPort = 3868
Example Realm Route Configuration:

% set addressContext ADDR_CONTEXT_1 diamNode diam realmRoute
camiant.nj.sonusnet.com realm camiant.nj.sonusnet.com
peer camiant.nj.sonusnet.com appId rx priority 1
1. peer name
2. realm
3. realmRoute name

45
CLI Reference Guide

Address Context
Diameter Node
Default values:
46
appId = rx (for PCRF interface)

state = disabled
priority = 0

CLI Reference Guide

DNS Group
Address Context
DNS Group
The DNS group object contains a list of DNS servers used to resolve SIP NAPTR,
SRV and 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 4 2 DNS Server Group Configuration
Creating and Configuring DNS Servers

You may create up to eight DNS servers. 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).
When a DNS group is configured at the Address Context level for an interface, it
must also be configured at the Zone level in that Address Context.

47
CLI Reference Guide

Address Context
DNS Group
Command Syntax
The DSN Group CLI syntax is shown below:
% set addressContext <addressContext name> dnsGroup
<dnsGroup name>
interface <interface name>
localRecord <record name>
data <#>
hostName <name>
server <DSN server name>
priority <0-100>
weight <0-100>
type <ip|mgmt|none>
CLI syntax to configure the type of IP interfaces to be used for this DNS Group:
<dnsGroup name> type <ip|mgmt|none>
CLI syntax to configure the local DNS resource record:
<dnsGroup name> localRecord <record_name>
data <index#>
priority <0-100>
type a
hostName <host_Name>
state <enabled|disabled>
CLI syntax to configure the DNS server for this address context:
<dnsGroup name> server <DNS server name>
ipAddress <DNS_ipAddress>
priority <0-100>
48

CLI Reference Guide

DNS Group
Address Context
weight <0-100>
CLI syntax to configure and display the type of IP interfaces to be used for this
DNS Group:
% set addressContext <addressContext_name> dnsGroup
<dnsGroup_name> type ip
-OR% set addressContext <addressContext_name> dnsGroup
<dnsGroup_name> type mgmt interface mgmtGroup
% show addressContext <addressContext_name> dnsGroup
<dnsGroup_name> type
Command Parameters
TABLE 4 2
Parameter
DNS Group Parameters

Length/
Range Description
Mandatory parameter descriptions
addressContext 1-23
The name of the address context, which is a container of objects that

correspond to a specific IP Addressing domain.
dnsGroup
1-23
The name of this DNS Group Entry.
type
N/A
The type of IP interfaces to be used for this DNS Group.

ip
mgmt
interface mgmtGroup management interface group name.
none (default)

49
CLI Reference Guide

Address Context
TABLE 4 2
DNS Group
DNS Group Parameters (Continued)
Parameter
Length/
Range Description
localRecord
N/A
The local DNS resource record name.

data The DNS record index number for this DNS record.
ipAddress Specifies the IPv4 or IPv6 address of the local name
service record data.
priority The local name service record data priority.
(range: 0-100 / default = 0).
state Administrative state of the local name service record data.
disabled (default)
enabled
type a 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 Lookup order is based on assigned priorities.
roundrobin Lookup order is in a circular round robin fashion.
state The state of this local name service record.
disabled (default)
enabled
server
N/A
The DNS server to be configured with in the DNS group.

ipAddress The IPv4 or IPv6 address of this DNS Server.
priority The DNS server priority. (range: 0-100 / default = 0).
recursionDesired Enable to use recursion for this DNS Server.
false
true (default)
state The Administrative state of DNS Server configuration.
disabled (default)
enabled
weight The load-sharing weight of this DNS Server.
(range: 0-100 / default = 0.
Non-mandatory parameter descriptions
displaylevel
1-64
To display different levels of output information in show commands.
interface
N/A
Specifies the name of the Management Interface group when using the
management interfaces.
4 10

CLI Reference Guide

DNS Group
Address Context
Command Examples
% set addressContext default dnsGroup dnsgrp33
% edit addressContext default dnsGroup dnsgrp33 interface
LIF1 localRecord 2 data 22 priority 2 state disabled type
% show addressContext default
dnsGroup DNS {
type none;
}
ipInterfaceGroup ipifgrp1 {
ipInterface ipif1 {
ceName
hornettest5;
portName
pkt0;
ipAddress 1.3.4.5;
prefix
24;
}
}
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. In the IP Signaling Profile, enable the noPortNumber5060 flag.

% set profiles signaling ipSignalingProfile <SIP IP
signaling profile name> commonIpAttributes flags
noPortNumber5060 enable

4 11
CLI Reference Guide

Address Context
DNS Group
4. 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>
5. Check the DNS server status and statistics:

% show table/status addressContext a1 dnsGroup DNSGroup1
dnsServerStatistics
dnsEntryStatus
dnsEntryDataStatus
4 12

CLI Reference Guide

Intercept
Address Context
Intercept
NOTE
Only Calea user can configure LI through EMA/ERE. See SBC 5x00
Operations Guide for descriptions of users and permissions.
SBC 5x00 provides Lawful Intercept (LI) support using one of two methods:
Using ERE with provisioning support from EMA.

Using centralized PSX with provisioning support from EMS (license required).
SBC 5x00 supports up to 500 simultaneous LI sessions. 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 ERE (or external PSX in
centralized PSX solution), the SBC 5x00 routes the call as directed and
additionally reports call events to the IS. It also sends an RTP copy of the calls
voice streams (call content) to an IP address provided by the IS. LI is configured
by EMA (or EMS in centralized PSX solution). The target number is uploaded to LI
table of ERE (or PSX, with the help of EMS).
NOTE
You can configure the LI using only the default AddressContext.
Command Syntax
As user Calea, use the following commands to configure LI:
% set addressContext <default> intercept
callDataChannel <callDataChannel>
displaylevel <displaylevel>
nodeNumber <integer>
As user Calea, use the following command to establish the LI call data channel
configuration:
% set addressContext <default> intercept callDataChannel
<callDataChannel_name>
ipInterfaceGroupName <ipInterfaceGroup_Name>
kaTimer <kaTimer_name>
priIpAddress <value>
priMode <outofservice | standby>
4 13
CLI Reference Guide

Address Context
Intercept
priPort <priPort_name>
priState <disabled | enabled>
retries <value>
secIpAddress <IP_Address>
secMode <active | outofservice | standby>
secState <disabled | enabled>
As user Calea, use the following command in System-level mode to retrieve the
LI statistics:
> show status addressContext <default> intercept
<intexierceptCallDataChannelStatistics>
Command Parameters
TABLE 4 3
Intercept Parameters
Parameter
Length/
Range
Description
intercept
1-23
Lawful Intercept Call Data Channel list for this address context.
CallDataChannel
NA
The user-configured LI Call Data Control Channel name.
nodeNumber
NA
The global unique node number for the SBC 5x00 used by the LI
Server for ID.
ipInterfaceGroup NA
Name
Name of the IP interface group used to stream to the LI Server.
kaTimer
0-65535
The Keep Alive Timer value, in seconds. (default = 5)
priIpAddress
NA
The primary LI Server's IPv4 address where Call Data Channel

messages are sent. (default = 0.0.0.0)
priMode
NA
Mode of the primary server. Options are:

active (default)
outOfService
standby
priPort
0-65535
The primary LI Server's UDP port where Call Data Channel messages
are sent. (default = 0)
pristate
NA
Use this flag to enable/disable communication to the primary LI Server.

enabled (default)
disabled
retries
NA
Number of retries before the LI Call Data Channel is considered as

failed. (default = 3)
secIpAddress
NA
Secondary LI Server's IPv4 address where Call Data Channel

messages are sent. (default == 0.0.0.0)
4 14

CLI Reference Guide

Intercept
TABLE 4 3
Address Context
Intercept Parameters
Parameter
Length/
Range
secMode
NA
Description
Mode of the secondary server. Options are:
active
outOfService (default)
standby
secState
NA
Use this flag to enable/disable communication to secondary LI Server.

enabled (default)
disabled
Command Examples
% show status addressContext default intercept
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;
}

4 15
CLI Reference Guide

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.
The default IP ACL supports 20 Record-Routes.
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 addressContext <addressContext_name>
ipAccessControlList...
// Mandatory parameters.
rule <rule_name>
precedence <1-65535>
// Non-mandatory parameters.
action <accept|discard>
bucketSize <bucket_size>
destinationAddressPrefixLength <length>
destinationIpAddress <IPv4/IPv6 Address>
destinationPort <port number>
fillRate <#>
ipInterface <ipInterface name>
ipInterfaceGroup <ipInterfaceGroup name>
mgmtIpInterface <mgmtIpInterface name>
mgmtIpInterfaceGroup <mgmtIpInterfaceGroup name>
protocol <any|0255>
sourceAddressPrefixLength <0-128>
sourceIpAddress <IPv4/IPv6 Address>
sourcePort <port number>
state <disbled|enabled>
4 16

CLI Reference Guide

Address Context
Command Parameters
TABLE 4 4
IP Access Control List Parameters
Parameter
Length/
Range
Description

addressContext
1-23
The name of the address context. The address context is a

Addressing domain.
rule
N/A
Access Control List rule name.

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, the IP ACL
rule with the highest precedence is applied for that incoming
packet.
action
N/A
Action to take when this rule is matched.

accept (default) Incoming packets matching this ACL
rule are accepted into the system.
discard Incoming packets matching this ACL rule are
discarded (not allowed into system).
bucketSize
1-255, or
unlimited
destinationAddressPre N/A
fixLength
The policing bucket size (in packets). It represents a credit

balance that should be consumed before the packets are
discarded. The consumed credits reside in the bucket and gets
reduced for every packet received on the Network Interface
(NI). If a packet is received when the credit balance is less than
the size of the packet, the packet is discarded subjected to the
discard rate set in the IP Policing Alarm profile or in the Policer
Alarm monitoring this NIF. (default is unlimited, which allows
continuous policing)
The length of destination IP address prefix which must match
the protocol. (default = 0).
N/A
The destination IPv4 or IPv6 address to match.

(default = 0.0.0.0).
destinationPort
0-65535,
or any
Destination port to match. (default = any).
fillRate
1-10000,
or
unlimited
The number of packets to add to the bucket credit balance (in

packets/second). If a packet is received at a rate exceeding
this fill rate, it is discarded subjected to the discard rate set in
the IP Policing Alarm profile or in the Policer Alarm monitoring
this NIF. The bucket credit balance is always less than the
configured bucket size regardless of the size of this increment.
(default = unlimited, which passes packets unconditionally).
ipInterface
N/A
Enter IP interface name to match, or any to match any IP

interface.
ipInterfaceGroup
N/A
Enter IP interface group name to match, or any to match any

IP interface group.

4 17
CLI Reference Guide

Address Context
TABLE 4 4
IP Access Control List Parameters (Continued)
Parameter
Length/
Range
mgmtIpInterface
N/A
Enter MGMT IP interface name to match, or "any" to match

any MGMT IP interface.
N/A
Enter MGMT IP interface group name to match, or "any" to

match any MGMT IP interface group.
precedence
1-65535
Use this parameter to specify the precedence of when the rule

is loaded and executed over other rules for each incoming
packet. If an incoming packet matches two identical rules, then
IP ACL rule with the highest precedence is applied for that
incoming packet.
Description
Each IP ACL rule must have a unique precedence value so the

rule is applied in the proper order.
protocol
N/A
Enter IP protocol type for use as a criterion of the IP input

match. Choices are 0-255, or one of the following:
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.
sourceAddressPrefixLe N/A
ngth
The length of source IP address prefix which must match the

protocol (default = 0).
sourceIpAddress
N/A
The source IPv4 or IPv6 address to match.

(default = 0.0.0.0).
sourcePort
0-65535,
or any
The source IP port to match. (default = any)
state
N/A
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.
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
4 18

CLI Reference Guide

Address Context
% show addressContext default ipAccessControlList

rule 2 {
precedence
22;
protocol
any;
ipInterfaceGroup
ipInterfaceGroup1;
ipInterface
ipInterface1;
sourceIpAddress
10.32.22.145;
sourceAddressPrefixLength
1;
10.34.25.153;
destinationAddressPrefixLength 2;
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
1;
protocol
any;
sourceIpAddress
0.0.0.0;
sourceAddressPrefixLength
0;
0.0.0.0;
destinationAddressPrefixLength 0;
sourcePort
any;
destinationPort
any;
action
accept;

4 19
CLI Reference Guide

Address Context
fillRate
unlimited;
bucketSize
unlimited;
state
disabled;
}
To view the configured rules and precedence from System-level CLI:
> show table addressContext default ipAccessControlList rule
> show table addressContext default ipAccessControlList
To view statistics from System-level CLI:
> show table addressContext a1 ipAccessControlList
ipAclRuleStatistics
If using a management interface group other than the default, 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 example, 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
mgmtGroup1 protocol udp bucketSize 10 fillRate 50
mgmt2_123 sourcePort 123 mgmtIpInterfaceGroup mgmtGroup1
protocol udp bucketSize 4 fillRate 4 precedence 103 state
enabled
mgmt2_162 sourcePort 162 mgmtIpInterfaceGroup mgmtGroup1
4 20

CLI Reference Guide

Address Context
protocol udp bucketSize 10 fillRate 10 precedence 104

state enabled
mgmt2_1812 sourcePort 1812 mgmtIpInterfaceGroup
precedence 105 state enabled
mgmt2_1813 sourcePort 1813 mgmtIpInterfaceGroup
precedence 110 state enabled
To display the configured IP ACL details from System-level CLI:
> show table addressContext default ipAccessControlList rule
SOURCE DESTINATION
IP MGMT IP SOURCE
INTERFACE IP
PREFIX SOURCE
ADDRESS ADDRESS
INTERFACE
DESTINATION
MGMT IP
IP PREFIX
FILL BUCKET
DESTINATION
NAME PRECEDENCE PROTOCOL GROUP INTERFACE GROUP INTERFACE ADDRESS

LENGTH
IP ADDRESS
LENGTH PORT
PORT ACTION RATE SIZE
STATE
--------------------------------------------------------mgmt2_22 200 tcp mgmtGroup1 - 0.0.0.0
any
22
accept 100
10
0 0.0.0.0 0
enabled

4 21
CLI Reference Guide

Address Context
mgmt2_80 201 tcp - - mgmtGroup1 - 0.0.0.0

any
80
accept 100
10
0 0.0.0.0 0
enabled
mgmt2_123 103 udp - - mgmtGroup1 - 0.0.0.0

123
any
accept 4
4
0 0.0.0.0 0
enabled

any
161
accept 50
10
0 0.0.0.0 0
enabled

162
any
accept 10
10
0 0.0.0.0 0
enabled

any
443
accept 100
10
0 0.0.0.0 0
enabled

1812
any
accept 4
4
0 0.0.0.0 0
enabled

1813
any
accept 1200 250
0 0.0.0.0 0
enabled

any
2022
accept 10
10
0 0.0.0.0 0
enabled

any
2024
accept 2500 250
0 0.0.0.0 0
enabled
To view the default system IP ACL statistics: from System-level CLI

defaultAclStatistics
NOTE
System ACLs are displayed only for default AddressContext.

addressContextID <value>
application <value>
bucketSize <<=64>
creditRate <value>
destinationIpAddress <IP Address>
lifGrpId <lifGrpId_value>
packetAccept <integer>
packetDiscard <integer>
PolId <integer>
polPriority <integer>
policingMode <integer>
4 22

CLI Reference Guide

Address Context
protocol <value>
sourceIpAddress <IP Address>
System ACL Command Parameters

TABLE 4 5
System ACL Parameters
Parameter
Length/
Range
Description
addressContextID
NA
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.
destinationIpAddress NA
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 ACL policer.
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 protocol type of the rule.
sourceIpAddress
NA
Displays the source IP address, Port Number and Prefix length.

4 23
CLI Reference Guide

Address Context
FIGURE 4 3 Default System IP ACL Statistics
4 24

CLI Reference Guide

IP Interface Group
Address Context
IP Interface Group
An IP Interface Group is a named object containing one or more IP interfaces (IP

addresses). The IP Interface Group is Address Context specific (e.g. permanently
bound to a particular Address Context), and is the primary tool to manage disjoint
networks (administrative network separation). An IP Interface Group is the local
manifestation of a segregated network domain.
The service section of an IP trunk group and a Signaling Port typically reference
an IP Interface Group in order to restrict signaling and/or media activity to that IP
Interface Group.
NOTE
The IP Interface on media ports 0 and 1 is designated set 1, and the IP

Interface on media ports 2 and 3 is set 2. While associating an IP
Interface to an IP Interface Group, the IP Interface must be from the
same set (set 1 or set 2), and is defined at the configuration level.
NOTE
When calculating bandwidth size, keep in mind that an IPv6 header size
(40 bytes) is twice as large as IPv4 header (20 bytes), thus reducing the
number of messages when using IPv6.
Command Syntax
// Mandatory parameters required to configure an IP Interface Group.
% set addressContext <addressContext_name> ipInterfaceGroup
<ipInterfacegroup_name>
ipInterface <ipInterface_name>
action <dryup|force>
bandwidth <bandwidth_value>
bwContingency <bwContingency_value>
dryupTimeout <#>
ipAddress <IP Address>
mode <inService|Outofservice>
portName <mgmt0|mgmt1|pkt0|pkt1|pkt2|pkt3>
prefix <(unsignedInt) 0-128>

4 25
CLI Reference Guide

Address Context
IP Interface Group
// Non-mandatory parameters that can be used to configure an IP Interface Group.

% set addressContext <addressContext_name> ipInterfaceGroup
<ipInterfacegroup_name> ipInterface <ipInterface_name>
altIpAddress <IP Address>
altPrefix <(unsignedInt) 0-128>
ceName <ce_name>
vlanTag <vlanTag_name>
% show addressContext <addressContext_name> ipInterfaceGroup
<ipInterfacegroup_name> ipInterface <ipInterface_name>
altIpAddress <IP Address>
altPrefix <(unsignedInt) 0-128>
bandwidth <bandwidth_value>
bwContingency <bwContingency_value>
ceName <ceName_name>
dryupTimeout <<>60>
ipAddress <IP Address>
mode <inService|Outofservice>
portName <mgmt0|mgmt1|pkt0|pkt1|pkt2|pkt3>
prefix <(unsignedInt) 0-128>
vlanTag <vlanTag_name>
% show addressContext <addressContext_name> ipInterfaceGroup
<ipInterfacegroup_name> ipsec enabled displaylevel
<(positiveInteger, <= 64)>
% delete addressContext <addressContext_name>
ipInterfaceGroup <ipInterfacegroup_name> ipInterface
<ipInterface_name>
4 26

CLI Reference Guide

IP Interface Group
Address Context
Command Parameters
TABLE 4 6
IP Interface Group Parameters
Parameter
Length/
Range
Description
addressContext
1-23

domain.
ipInterfaceGroup
1-23
A group of IP interfaces for the specified address context.

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.
ipsec
N/A
Administrative state of the IPsec support for this interface group.

disabled (default) IPsec support is off for all interfaces in
the group.
enabled IPsec support is on for all interfaces in the group.
ipInterface
1-23
Specifies the IP interface name.

NOTE: SBC 5x00 supports a maximum of 4096 IP interfaces.
action
Action to take when putting the IP Interface out of service:

dryUp
force
bandwidth
0-2147483647 Maximum amount of bandwidth allowed in units of bytes or

seconds for this IP interface.
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
0-100
The percentage of maximum bandwidth reserved for

contingency (that is, non-media).
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.
dryupTimeout
1-1440
The dryup timeout in minutes (e.g. the number of minutes to wait

for active calls to complete before dropping the call).
(default = 10)

4 27
CLI Reference Guide

Address Context
TABLE 4 6
IP Interface Group
IP Interface Group Parameters (Continued)
Parameter
Length/
Range
ipAddress
N/A
Description
The primary IP Address of the Interface. The following IP
address types are supported:
IPv4 This is V4 IP address in dotted decimal form (for
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).
NOTE: Duplicate Address Detection procedures are
performed on interfaces configured with IPv6 addresses.
If a duplicate address is found in the network, a warning
message is output to Linux logs at /var/log/syslog and
/var/log/messages.
Example message:
Nov 12 08:52:35 SBC-1 kernel: [854194.740638] mgt1:
IPv6 duplicate address fc00::100:0:0:100:1 detected
N/A
mode
The operational mode of the NIF:

inService (default) This state is set by default when state
is enabled.
outOfService Set mode to outOfService before
changing the state to disabled.
portName
N/A
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.
Packet ports (pkt) identify the physical ports used for signaling
and media, whereas media ports are UDP ports used to carry
media traffic.
NOTE: ipInterfaceGroup and ipInterface should not be
configured for mgmt0 and mgmt1 ports. Instead,
configure mgmt0 and mgmt1 ports using
mgmtIpInterfaceGroup and mgmtIpInterface.
prefix
4 28
1-3
Specifies the IP subnet prefix of this Interface. Must be 0-128.

Default value is 16.

CLI Reference Guide

IP Interface Group
TABLE 4 6
Address Context
IP Interface Group Parameters (Continued)
Parameter
Length/
Range
Description
state
N/A
Administrative state of the network interface.

disabled (default) In this state the IP interface is inactive
and does not respond to a ping.
enabled In this state the IP interface is active and responds
to a ping if the Ethernet cable is connected.

altIpAddress
N/A
Specifies alternative (secondary) IP address for the configured

packet IP interface. The alternative IP address is optional, but if
used must be a different IP address type than ipAddress
parameter.
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 the alternative IP address only after changing
the Packet IP interface to disabled state.
altPrefix
1-3
Alternative IP subnet prefix of this interface. It must be between

0-128.
ceName
1-255
The name of the computing element that hosts the port used by
this IP interface.
NOTE: ceName identifies the node. Insert node name in
case the system is not redundant. Insert the system name if
the system is deployed in full 1:1 redundancy.
vlanTag
1-4
Specifies the VLAN TAG assigned to this physical interface. It

must be between 2-4095.
NOTE: The parameter vlanTag is exclusive on a physical
port. Therefore, SBC 5x00 does not create two LIFs with the
same vlanTag on the same physical port.
displaylevel
1-64
To display different levels of output information in show

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;

4 29
CLI Reference Guide

Address Context
IP Interface Group
ipAddress 10.34.25.151;
prefix
24;
altPrefix 33;
mode
inService;
state
enabled;
}
}
ipInterfaceGroup LIF2 {
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 {
4 30
ceName
sbx30;
portName
mgmt0;
ipAddress
1.2.3.4;
prefix
1;
altIpAddress
2001:DB8:85A3::8A2E:370:7334;
altPrefix
3;
action
dryUp;
CLI Reference Guide

IP Interface Group
Address Context
dryupTimeout
60;
bwContingency 0;
vlanTag
2;
bandwidth
1;
}
}
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

4 31
CLI Reference Guide

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 7 105).
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:
Discarddiscard the packet

Bypasspass the packet on without modification
Protectencrypt the packet according to an encryption algorithm that has
been mutually agreed to by the session peers
The SPD entry PRECEDENCE establishes that entrys 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.
4 32

CLI Reference Guide

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 configuration, status, and statistics pertaining to these objects.

4 33
CLI Reference Guide

Address Context
IPsec
Command Syntax
// Mandatory parameters that are required to configure the IPSec.
% set addressContext <addressContext name> ipsec peer <peer
name>
ipAddress <ipAddress>
preSharedKey <DES3 | encrypted | string>
protocol <ikev1>
% set addressContext <addressContext name> ipsec spd
<spd_name>
action <bypass | discard | protect>
localIpAddr <ipAddress>
localIpPrefixLen <unsignedInt | <= 128>
localPort <0 to 65535>
precedence <unsignedShort>
protocol <0 to 255>
remoteIpAddr <ipAddress>
remoteIpPrefixLen <unsignedInt | <= 128>>
remotePort <0 to 65535>
state <disabled | enabled>
// Non-manadatory parameters that can be used to configure the IPSec.
% set addressContext <addressContext name> ipsec peer
<peer_name>
localIdentity <fqdn | ipV4Addr | ipV6Addr>
protectionProfile <profile_name>
remoteIdentity <fqdn | ipV4Addr | ipV6Addr>
% show addressContext <addressContext name> ipsec
displaylevel <positiveInteger | <= 64>>
peer <ipAddress | localIdentity | preSharedKey |
protectionProfile | protocol | remoteIdentity>
spd <action | localIpAddr | localIpPrefixLen | localPort
peer | precedence | protectionProfile |
protocolremoteIpAddr | remoteIpPrefixLen
|remotePortstate>
% show addressContext <addressContext name> ipsec peer
<peer_name>
4 34

CLI Reference Guide

IPsec
Address Context
localIdentity <fqdn | ipV4Addr | ipV6Addr>

preSharedKey <DES3 | encrypted | string>
protectionProfile <profile_name>
protocol <0 to 255>
remoteIdentity <fqdn | ipV4Addr | ipV6Addr>
% show addressContext <addressContext_name> ipsec spd
<spd_name>
action <action>
bypass
discard
protect
localIpAddr <ipAddress>
localIpPrefixLen <unsignedInt | <= 128>
localPort <0 to 65535>
precedence <unsignedShort>
protocol <0 to 255>
remoteIpAddr <ipAddress>
remoteIpPrefixLen <unsignedInt | <= 128>>
remotePort <0 to 65535>
state <disabled | enabled>
% delete addressContext <addressContext_name> ipsec peer
<peer_name>
% delete addressContext <addressContext> ipsec spd
<spd_name>
% request addressContext <addressContext_name> ipsec
ikeSaDelete <saIndex>
ikeSaDeleteAll <ikeSaDeleteAll>
ipsecSaDelete <localSPI>

4 35
CLI Reference Guide

Address Context
IPsec
Command Parameters
TABLE 4 7
IPSec Parameters
Parameter
Length/
Range
Description
Mandatory peer parameter descriptions for IPSec

addressContext
1-23
Specifies the name of the address context. The address context

is a container of objects that correspond to a specific IP
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 32 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
4 36

CLI Reference Guide

IPsec
TABLE 4 7
Address Context
IPSec Parameters (Continued)
Parameter
Length/
Range
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 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.
protectionProfile
N/A
Specifies the name of the ike protection profile to be applied to

the Key management protocol exchange with this peer.
remoteIdentity
N/A
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).

4 37
CLI Reference Guide

Address Context
TABLE 4 8
IPsec
SPD Parameters
Parameter
Length/
Range
Description
Mandatory SPD parameter descriptions for IPSec.

addressContext
1-23
Specifies the name of the address context. The address context

is a container of objects that correspond to a specific IP
spd
1-23
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
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
Specifies the local IPv4 or IPv6 address of the SPD traffic

selector.
localIpPrefixLen
0-128
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
Evaluation order of this entry. Zero indicates wildcard.
protocol
0-255
Specifies the IP protocol number of the SPD traffic selector. This

parameter uses IANA protocol number assignment, that is,
protocol number 6 represents TCP, protocol number 17
represents UDP. 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.
remoteIpPrefixLen
0-128
Specifies the remote IP prefix length of the SPD traffic selector.

Zero indicates wildcard. Default value is 0.
remotePort
0-65535
Specifies the remote port of the SPD traffic selector. Zero

indicates wildcard. Default value is 0.
state
N/A
Administrative state to disable or enable a SPD entry. Zero

indicates wildcard.
displaylevel
1-64

commands.
4 38

CLI Reference Guide

IPsec
Address Context
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;
}
preSharedKey
$3$w4J4dBuetKw=;
protectionProfile protprofile1;
}
To display the IPsec SPD:
% show addressContext ipsec spd spd2

4 39
CLI Reference Guide

Address Context
IPsec
Command Parameters
TABLE 4 9
IPSec SA Delete Parameters
Parameter
Length/
Range
Description
ikeSaDelete
N/A
Specifies to delete a specific IKE SA and its IPSEC SAs.
ikeSaDeleteAll
N/A
Specifies to delete ALL IKE and IPSEC SAs. This is an ungraceful

delete, that is, Peer will not be notified.
ipsecSaDelete
N/A
Specifies that only local SPI is required, i.e, deletes the IPsec SA pair
incoming Security Parameter Index value (LOCAL SPI).
4 40

CLI Reference Guide

Link Detection Group
Address Context
The 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 ping
pong type of 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 are raised regardless of whether LVM is configured.
NOTE
If no LDG is configured on the management ports, then SBC 5x00

allows manual switchover.
Command Syntax
linkDetectionGroup <linkdetectionGroup_name>
linkMonitor <linkMonitor_name>
reattemptTimer <300-10000>
responseTimer <500-10000>
retries <1-10>
threshold <0-10>
type <ip|mgmt>
verifyTimer <1000-60000>

4 41
CLI Reference Guide

Address Context
% show addressContext <addressContext_name>

linkDetectionGroup <linkDetectiongroup_name>
linkMonitor <linkMonitor>
retries <1-10>
threshold <0-10>
type <ip|mgmt>
linkDetectionGroup <linkDetectionGroup_name>
4 42

CLI Reference Guide

Address Context
Command Parameters
TABLE 4 10 Link Detection Group Parameters
Parameter
Length/
Range
addressContext
1-23
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.
linkDetectiongroup
N/A
Table of user configured link detection group.
ceName
1-23
Specifies the name of the computing element (CE) that hosts this
link detection group.
Description
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.
reattemptTimer
30010000
Time (in milliseconds) to wait for a link verification reattempt.

(default = 1000).
responseTimer
50010000
Time (in milliseconds) to wait for a link verification attempt. (default

= 1000).
retries
1-10
Specifies the number of retries before link verification is

considered failed. (default = 3).
state
N/A
Administrative state of the Link Detection Group.

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.
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
displaylevel
100060000
Time interval between link verification attempts. Default is 15000.
1-64

commands.
It is the frequency at which an ICMP echo request is sent.

4 43
CLI Reference Guide

Address Context
Command Example
To display the configuration of all link detection parameters:
// Management link detection group
% show addressContext default linkDetectionGroup a1_mgmt_ldg
ceName
sbx48.eng.sonusnet.com;
type
mgmt;
threshold
1;
verifyTimer
1000;
responseTimer
500;
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
4 44
ceName
type
ip;
threshold
1;
verifyTimer
1000;
responseTimer
500;
CLI Reference Guide

Address Context
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;
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;

4 45
CLI Reference Guide

Address Context
responseTimer
1000;
reattemptTimer
1000;
state
enabled;
}
linkMonitor LM1-A1 {
interfaceGroup
IFG-INT;
interface
lif_eth1;
destination
10.9.48.165;
verifyTimer
15000;
responseTimer
1000;
reattemptTimer
1000;
state
enabled;
}
}
To display the link detection group statistics:
% show table addressContext default
NAME
SINGLE
DOUBLE
FAILURES
FAILURES
FAILURES
------------------------------------------pkt0_ldg39
pkt0_ldg48
a1_mgmt_ldg
a2_mgmt_ldg
To display the link detection group status:

show table addressContext default linkDetectionGroupStatus
NAME
FAILURES
----------------------pkt0_ldg39
pkt0_ldg48
a1_mgmt_ldg
a2_mgmt_ldg
[ok][2011-06-14 11:26:27
4 46

CLI Reference Guide

Address Context
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 4 41 .
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.
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
// Mandatory parameters required to configure a Link Monitor.
linkDetectionGroup <LDG_name> linkMonitor <name>
destination <IP Address>

4 47
CLI Reference Guide

Address Context
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-mandatory parameters that can be used to configure a Link Monitor.
interface <interface_name>
interfaceGroup <interfaceGroup_name>
retries <1-10>
% show addressContext <addressContext_name>
destination <IP address>
interface <interface_name>
interfaceGroup <interfaceGroup_name>
retries <1-10>
4 48

CLI Reference Guide

Address Context
Command Parameters
TABLE 4 11 Link Monitor Parameters
Length/
Range
Parameter
Description
Mandatory parameter descriptions for Link Monitor.

addressContext
1-23
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.
destination
N/A
Destination IPv4 or IPv6 address for link verification.
state
N/A
Administrative state for link verification for the IP interface.

Non-mandatory parameter descriptions for Link Monitor.

linkDetectionGroup
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 4 41.
linkMonitor
1-23
Specifies a link monitor that monitors a link to a destination for a

specific interface.
interface
N/A
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.
interfaceGroup
N/A
reattemptTimer
N/A
Specifies the name of the IP interface group to be monitored.

Time to wait for a link verification reattempt.
Minimum timer value is 300 (milliseconds). The reattempt timer
has no default for LinkMonitor. The default for
LinkDetectionGroup is 1000 (milliseconds).
responseTimer
N/A
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
retries
N/A
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
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
displaylevel
1-64

commands.

4 49
CLI Reference Guide

Address Context
Command Example
To display the configuration of all link detection parameters:
% show details addressContext defaultAddressContext
linkDetectionGroup Alpha linkMonitor Alpha-1
addressContext
defaultAddressContext;
interfaceGroup
IFG_AS;
interface
LIF_ETH2;
destination
10.160.48.230;
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
4 50

CLI Reference Guide

Address Context

% commit
ipInterface pkt0.50 state enable mode inservice
% 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

4 51
CLI Reference Guide

Address Context

verifyTimer 1000 responseTimer 500 reattemptTimer 300
linkMonitor mgmt1_lm destination 10.151.41.15
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
4 52

CLI Reference Guide

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

4 53
CLI Reference Guide

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
4 54

CLI Reference Guide

Address Context

reattemptTimer 300
pkt1.50
reattemptTimer 300
% commit
linkMonitor pkt0.50_lm state enabled
% commit
state enabled
state enabled
% commit

4 55
CLI Reference Guide

Address Context
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
pkt0.51
reattemptTimer 300
pkt1.51
reattemptTimer 300
4 56

CLI Reference Guide

Address Context

pkt0.51
reattemptTimer 300
pkt1.51
reattemptTimer 300
% commit
% commit
state enabled
4 57
CLI Reference Guide

Address Context

state enabled
% commit
To configure link detection on the 52-net:
pkt2.52
reattemptTimer 300
pkt3.52
reattemptTimer 300
4 58

CLI Reference Guide

Address Context

pkt2.52
reattemptTimer 300
pkt3.52
reattemptTimer 300
% commit
% commit

4 59
CLI Reference Guide

Address Context

state enabled
state enabled
% 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
578
mgmt2_lm
0
478
8135
1225
578
To display the link monitor status:

% show table addressContext default linkDetectionGroup
a1_mgmt_ldg linkMonitorStatus
NAME
MONITOR
LINK
STATUS
STATUS
------------------------------
4 60
mgmt1_lm
monitoring
up
mgmt2_lm
monitoring
up

CLI Reference Guide

NAT Direct Media Group
Address Context
The NAT Direct Media Group is a collection of public signaling IP addresses for
NAT devices supporting Direct Media (DM). A NAT Direct Media Group name can
be maximum of 32 characters; however, 0.0.0.0 (IPv4) and ::0 (IPv6) are not
allowed.
To allow Direct Media between NAT devices, or between NAT and Non-NAT
devices, the following configuration is necessary.
1. Enable directMediaAllowedBehindNAPT and DM flags at the Trunk

Group level.
2. For Direct Media between endpoints behind same NAT, ensure the signaling
IPs of the endpoints match.
3. For Direct Media across NAT devices, or from NAT to Non-NAT (Hybrid
Networks), configure/group the Signaling IPs of the NAT or Non-NAT device
(for Hybrid networks) in the new NAT Direct Media Group table at the Address
Context level.
Direct Media is disallowed under following conditions:
1. One or both endpoints are behind NAT and directMediaAllowedBehindNAPT

flag is disabled.
2. If directMediaAllowedBehindNAPT flag is enabled and Signaling IPs of the

NAT devices do not match.
3. Signaling IPs of the NAT or Non-NAT (for Hybrid Networks) devices are not
grouped in the same NAT Direct Media Group Table.
4. Address Context name of both endpoints do not match.

5. If the call is a Lawful Intercept call.
Command Syntax
The CLI syntax to enable Direct Media with NAPT at Trunk Group level is shown
below (see "sipTrunkGroup" on page 4 99 for details):
% set addressContext <name> zone <name> sipTrunkGroup <TGName> media directMediaAllowedBehindNapt <disable|enable>
The CLI syntax to group the endpoint signaling IP addresses for which to allow
Direct Media with NAPT is shown below:
% set addressContext <name> natDirectMediaGroup <groupName>
dmNatPrefix <IpV4_Address> <prefixLen>

4 61
CLI Reference Guide

Address Context
Command Parameters
TABLE 4 12 NAT Direct Media Group Parameters
Parameter
Length/
Range
natDirectMediaGroup
1-23
Name of group of signaling IP addresses for NAT devices

supporting Direct Media residing in NAPT Qualification Table.
dmNatPrefix
N/A
Grouped public signaling IP addresses of NAT devices that

allow direct media. This field consists of an IP address and
prefix as specified below:
Description
<IP_address> The public signaling IPv4 or IPv6 address

of this prefix.
NOTE: IP address 0.0.0.0 or ::0 is not allowed in the
configuration.
<prefix_length> The length (in bits) of the prefix.
(IPv4 length: 1-32. IPv6 length: 1-128).
Command Example
admin@SEMAL% show addressContext ADDRESS_CONTEXT_1
natDirectMediaGroup
natDirectMediaGroup DM_GROUP_1{
dmNatPrefix 10.70.52.91 32;
dmNatPrefix 10.70.52.127 32;
dmNatPrefix 10.70.52.143 32;
}
admin@SEMAL% show addressContext ADDRESS_CONTEXT_1
natDirectMediaGroup
natDirectMediaGroup DM_GROUP_2{
dmNatPrefix 10.70.52.92 32;
dmNatPrefix 10.70.52.127 32;
}
4 62

CLI Reference Guide

RTP Server Table
Address Context
RTP Server Table
The RTP Server Table is a table of trusted SIP Servers maintained on the SBC
5x00. In certain environments, the receipt of a SIP response such as 18x from
the peer directs the SBC 5x00 to decide whether or not to open the media path
(for early cut through). This early cut through is allowed from trusted configured
RTP Servers.
Command Syntax
% set addressContext <addressContext_name> rtpServerTable
<table_name> rtpServer <IP_address> <prefix>
Command Parameters
TABLE 4 13 RTP Server Table Parameters
Parameter
Length/
Range
Description
rtpServerTable
1-23
RTP server table name.
rtpServer
N/A
Use this control to enter:

IP address
Prefix length, in bits (range: 0-128)
Command Example
% set addressContext AC-1 rtpServerTable RTP_entries1
rtpServer 10.11.12.13 12
% show addressContext AC-1 rtpServerTable RTP_entries1
rtpServer 10.11.12.13 12;

4 63
CLI Reference Guide

Address Context
Static Route
Static Route
The staticRoute object is used to configure:
"Static IP Routes for IP interfaces" on page 4 64

"Static Route for Management Interfaces" on page 4 66
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_name> staticRoute
<destinationIpAddress>
<prefix> <nextHopIPaddress> <ipInterfaceGroupName>
<ipInterfaceName> preference <preferenceNumber>
% show addressContext <addressContext_name> staticRoute
<destinationIpAddress>
preference <preferenceNumber>
% delete addressContext <addressContext> staticRoute
<IpAddress>
Command Parameters
TABLE 4 14 Static Route Parameters
Parameter
Length/
Range Description
addressContext
1-23
4 64

domain.

CLI Reference Guide

Static Route
Address Context
TABLE 4 14 Static Route Parameters (Continued)

Length/
Range Description
Parameter
<destinationIpAddress> N/A
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).
<prefix>
N/A
The IP prefix of this static route entry.
<nextHopIPaddress>
N/A
The IPv4 or IPv6 address of the next system en route to the

destination.
<ipInterfaceGroupName> N/A
The name of the IP interface group.
<ipInterfaceName>
N/A
The name of the IP interface for this entry.
preferenceNumber
N/A
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;
}
preference 1;
}
preference 10;

4 65
CLI Reference Guide

Address Context
Static Route
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 8 40.
4 66

CLI Reference Guide

Zone
Address Context
Zone
A zone is used to group a set of objects unique in a particular customer

environment. A zone can contain 1 SIP signaling port and/or 1 H.323 signaling
port but, up to 16 ports are allowed. A zone can contain multiple SIP and H.323
trunk groups.
The following Zone parameters are defined in this section:
"cac" on page 4 71
"dnsGroup" on page 4 74
"gwSigPort" on page 4 74
"gwTrunkGroup" on page 4 76
"h323SigPort" on page 4 80
"h323TrunkGroup" on page 4 81
"id" on page 4 91
"ipPeer" on page 4 92
"messageManipulation" on page 4 96
"remoteDeviceType" on page 4 96
"sipSigPort" on page 4 97
"sipTrunkGroup" on page 4 99
Command Syntax
% set addressContext <addressContext name> zone <zone name>
id <id #>
% set addressContext <addressContext name> zone <zone name>
cac <cac parameter>
dnsGroup <dnsGroup name>
gwSigPort <index #>
gwTrunkGroup <TRUNKGROUP_NAME>
h323SigPort <h323SigPort parameters>
h323TrunkGroup <TRUNKGROUP_NAME>
ipPeer <ipPeer name>
messageManipulation
<inputAdapterProfile|outputAdapterProfile>
remoteDeviceType <accessDevice|appServer|none>
sipSigPort <index #>
sipTrunkGroup <TRUNKGROUP_NAME>

4 67
CLI Reference Guide

Address Context
Zone
// Gateway Signaling Port mandatory parameters:

ipInterfaceGroupName <name>
portNumber <#>
// Gateway Signaling Port non-mandatory parameters:
mode <outOfService|inService>
role <primary|secondary>
// Gateway Trunk Group mandatory parameters:
<TRUNKGROUP_NAME>
accMc1Percent <% value>
accMc2Percent <% value>
accTimer <0-10>
action <dryUp|force|undefined>
dryUpTimeout <1-1440>
ingressIpPrefix <ip_address prefix_length>
// Gateway Trunk Group non-mandatory parameters:
cac
callReservation
media
packetOutage
// H.323 Signaling Port mandatory parameters:
h323SigPort <index #>
action <force|dryUp>
dscpValue <0-63>
h225IpAddress <ip address>
portNumber <1-65535>
// H.323 Signaling Port non-mandatory parameters:
h245IpAddress <ip address>
// H.323 Trunk Group mandatory parameters:
h323TrunkGroup <TRUNKGROUP_NAME>
4 68

CLI Reference Guide

Zone
Address Context
sendingCompleteEnbloc <disabled|enabled>
// H.323 Trunk Group non-mandatory parameters:
cac
callReservation
callRouting
media
packetOutage
parentSharedCacLimitsPoolName
policy
services
// IP Peer mandatory parameters:
<peer name>
// IP Peer non-mandatory parameters:
defaultForIp <false|true>
ipPort <0-65535>
pathCheck
policy
sip
surrogateRegistration
// SIP Signaling Port mandatory parameters:
<index #>
dscpValue <0-63>
recorder <disabled|enabled>
sctpProfileName <name>
tcpConnectTimeout <0-180>
tlsProfileName <name>
transportProtocolsAllowed <protocol list>
// SIP Signaling Port non-mandatory parameters:

4 69
CLI Reference Guide

Address Context
Zone
sipSigPort <sipSigPort>
ipAddressV4
ipAddressV6
// SIP Trunk Group mandatory parameters:
<TG_NAME>
action <dryUp|force>
downstreamForkingSupport <disabled|enabled>
recordingDNpreference <preference>
ucidSupport <none|passthruOrGenerate>
// SIP Trunk Group non-mandatory parameters:
cac <parameters>
callReservation <parameters>
callRouting <parameters>
congestionHandling <parameters>
media <parameters>
packetOutage <parameters>
parentSharedCacLimitsPoolName <name>
policy <parameters>
qoe <parameters>
services <parameters>
signaling <parameters>
% delete addressContext <addressContext> zone <zone>
% request addressContext <addressContext> zone <zone>
sipSigConnResetAll <sipSigConnResetAll>
sipSigPortResetAll <sipSigPortResetAll>
sipTrunkGroup <sipTrunkGroup>
4 70

CLI Reference Guide

Zone
Address Context
cac
Command Syntax
% set addressContext <addressContext_name> zone <zone_name>
cac
bandwidthLimit <0-2147483647, or unlimited>
bandwidthLimitThreshold <0-100>
callLimit <0-2147483647, or unlimited>
callLimitThreshold <0-100>
egress
callBurstMax <1-200, or unlimited>
callRateMax <1-100, or unlimited>
emergencyOversubscription <0-1000>
registerBurstMax <1-200, or unlimited>
registerRateMax <1-100, or unlimited>
ingress
callBurstMax <1-200, or unlimited>
callRateMax <1-100, or unlimited>
packetRateMax <1-65535, or unlimited>
registerBurstMax <1-200, or unlimited>
registerRateMax <1-100, or unlimited>
registrationLimit <0-2147483647, or unlimited>

4 71
CLI Reference Guide

Address Context
Zone
Command Parameters
TABLE 4 15 Zone CAC Parameters
Parameter
Length/
Range Description
zone
1-23
The name of the zone. You can configure signaling, media, and control for a
zone in the address context.
NOTE: Zone name is unique across all address contexts.
cac
N/A
Call Admission Control (CAC) parameters for all peers using this zone.
bandwidthLimit Total bandwidth limit in Kbps/sec. (range: 02147483647, or unlimited).
bandwidthLimitThreshold Bandwidth utilization notification
threshold, as a percentage. (range: 0-100 / default = 0)
callLimit Total number of calls allowed on this zone. (range: 02147483647, or unlimited / default is unlimited).
callLimitThreshold Call limit utilization notification threshold, as a
percentage. (range: 0-100 / default = 0)
egress Egress-specific call admission control configuration. The egress
call maximum limit parameters are as follows:
callBurstMax Maximum allowed burst (above the allowed sustained
rate) for egress call attempts. (range: 1-200, or unlimited / default is
unlimited).
callLimit Total number of outbound concurrent calls allowed.
(range: 0-2147483647, or unlimited / default is unlimited)
callRateMax Maximum sustained egress call rate allowed in calls/
second. (range: 1-100, or unlimited / default is unlimited).
NOTE: You can set both callRateMax and callBurstMax as
unlimited; however, if you assign a value to one parameter, the
other must also be assigned a value.
emergencyOversubscription Oversubscription of resources (as a

percentage) allowed for emergency calls. (range: 0-1000 / default = 10)
registerBurstMax Maximum allowed burst (above allowed
sustained rate) for egress initial SIP registrations. (range: 1-200, or
unlimited / default is unlimited).
registerRateMax Maxim sustained egress rate of initial SIP
registrations allowed on this zone. (range: 1-100, or unlimited / default is
unlimited).
NOTE: You can set both registerBurstMax and registerRateMax
as unlimited; however, if you assign a value to one parameter, the
4 72

CLI Reference Guide

Zone
Address Context
TABLE 4 15 Zone CAC Parameters (Continued)

Parameter
cac
(continued)
Length/
Range Description
N/A
emergencyOversubscription This parameter gives priority treatment

to emergency calls by specifying the resource oversubscription percentage
allowed for emergency calls, and represents the allowed percentage of
emergency calls beyond the configured call limit. When the call limit is
reached, normal calls are rejected but emergency calls are accepted up to
an expanded limit. (range: 0-1000, or unlimited / default = 10)
ingress Ingress-specific call admission control configuration. The
ingress call maximum limit parameters are as follows:
callBurstMax Maximum allowed burst (above the allowed sustained
rate) for ingress calls. (range: 1-200, or unlimited / default is unlimited).
callLimit Total number of inbound concurrent calls allowed. (range:
0-2147483647, or unlimited / default is unlimited)
callRateMax Maximum sustained ingress call rate allowed in calls/
second. (range: 1-100, or unlimited / default is unlimited).
NOTE: You can set both callRateMax and callBurstMax as
emergencyOversubscription Oversubscription of resources (as a

percentage) allowed for emergency calls. (range: 0-1000 / default = 10)
packetRateMax Maximum sustained packet rate allowed (in packets/
second). (range: 1-65535, or unlimited / default is unlimited).
registerBurstMax Maximum burst (above the allowed sustained
rate) for initial SIP registrations. (range: 1-200, or unlimited / default is
unlimited).
registerRateMax Maximum sustained rate of initial SIP
registrations allowed in registrations/second. (range: 1-100, or unlimited /
default is unlimited).
NOTE: You can set both registerBurstMax and registerRateMax
as unlimited; however, if you assign a value to one parameter, the
registrationLimit Number of registrations allowed on this zone.

(range: 0-2147483647, or unlimited / default is unlimited).

4 73
CLI Reference Guide

Address Context
Zone
dnsGroup
Command Parameters
TABLE 4 16 Zone DNS Group Parameters
Parameter
Length/
Range Description
zone
1-23
dnsGroup
N/A
Default DNS Server Group for this zone. For more information on DNS group,
refer to "DNS Group" on page 4 7.
gwSigPort
Command Syntax
gwSigPort <#>
portNumber <#>
Command Parameters
TABLE 4 17 Zone Gateway Signaling Port Parameters
Parameter
Length/
Range Description
zone
1-23
The name of the zone. For GW-to-GW calls, zone must be defaultSigZone.
You can configure signaling, media, and control for a zone in the address
context.
NOTE: Zone name must be unique across all address contexts.
4 74

CLI Reference Guide

Zone
Address Context
TABLE 4 17 Zone Gateway Signaling Port Parameters (Continued)

Parameter
Length/
Range Description
gwSigPort
1-2048
Gateway (GW) signaling ports for this zone. Enter an index number for this
port, and select parameters:
ipAddress IP Address of the Gateway Signal Listen Port, either in IPv4
or IPv6 format.
NOTE: An IPv4-mapped IPv6 address is not allowed.
ipInterfaceGroupName Name of IP interface group used by this
gateway signaling port.
mode The operational mode for this gateway signaling port.
inService (default)
outOfService
portNumber TCP Port number of gateway signaling port
(default = 2569).
role Role of the gateway signal listening port.
primary (default) Create a listening port for Gateway signaling traffic.
secondary An alternate port used for listening only and cannot be
used to establish new gateway signal links.
state Administrative state of gateway listening port.
disabled (default)
enabled

4 75
CLI Reference Guide

Address Context
Zone
gwTrunkGroup
Use this object to configure gateway trunk group parameters
NOTE
Command Syntax
% set addressContext <name> zone <name> gwTrunkGroup <name>
accMc1Percent <0-100>
accMc2Percent <0-100>
accTimer <0-10>
callReservation
inbound <0-100>
incomingCallMinimum <0-128>
outgoingCallMinimum <0-100>
priorityCallMinimum <0-100>
silc
MC1Percent <0-100>
MC2Percent <0-100>
ingressIpPrefix <IP address>
media
directMediaAllowed <disabled|enabled>
mediaIpInterfaceGroupName <name>
sourceAddressFiltering <disabled|enabled>
packetOutage
bandwidthLimitReduction <0-100>
detectionInterval <5-1440>
detectionState <disabled|enabled>
minimumCalls <0-65535>
minimumDuration <0-65535>
4 76

CLI Reference Guide

Zone
Address Context
Command Parameters
TABLE 4 18 Zone Gateway Trunk Group Parameters
Parameter
Length/
Range Description
zone
1-23
The name of the zone. You can configure signaling, media, and control
for a zone in the address context.
gwTrunkGroup
N/A
The gateway trunk groups for this zone. Parameters include:

accMc1Percent The percentage of calls to continue to send to a
remote congested gateway (in MC1).
(range: 0-100 percent / default = 90).
accMc2Percent Percentage of calls to continue to send to a
remote congested gateway (in MC2).
accTimer Automatic congestion control timer.
(range: 0-10 seconds / default = 0).
action -Action when putting this gateway trunk group out of service.
This object controls whether calls are forced off or allowed to dry up.
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 When selected, no new calls are accepted and all active
calls are immediately dropped.
undefined When selected, all calls are dropped and the
Gateway trunk group is immediately set to outOfService.
callReservation 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 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 (range: 0-100 percent).
incomingCallMinimum Minimum number of incoming call
allowed when reservations are enabled for this gateway trunk
group. (range: 0-128 / default =1).
outgoingCallMinimum Minimum percent of outgoing call
group. (range: 0-100 / default = 10).
priorityCallMinimum Minimum number of priority calls
group. (range: 0-100 / default =1).

4 77
CLI Reference Guide

Address Context
Zone
TABLE 4 18 Zone Gateway Trunk Group Parameters (Continued)

Parameter
gwTrunkGroup
(continued)
4 78
Length/
Range Description
N/A
silc The SILC traffic control configuration.

MC1Percent Percentage of calls to accept when the machine
congestion level is 1.
MC2Percent Percentage of calls to accept when the machine
congestion level is 2.
(range: 0-100 percent / default = 25.
state Administrative state to enable/disable the SILC traffic
control.
- disabled (default)
- enabled
state Administrative state of call reservation feature.
disabled (default)
enabled
dryUpTimeout Dryup timeout (in minutes) when this gateway trunk
group is outOfService with dryup action.
(range: 1-1440 minutes / default = 5).
ingressIpPrefix 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: The V4 IP address in dotted decimal form (for example
128.127.50.224).
IPv6: The V6 IP address in hexadecimal/colon form (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
prefixLength 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 Parameters associated with media features for this gateway
trunk group.
directMediaAllowed Enable to attempt to set up a directmedia path so that media flows directly between endpoints in the
same direct-media group.
disabled (default)
enabled
mediaIpInterfaceGroupName The interface group to be used
for media.

CLI Reference Guide

Zone
Address Context
TABLE 4 18 Zone Gateway Trunk Group Parameters (Continued)

Parameter
gwTrunkGroup
(continued)
Length/
Range Description
N/A
sourceAddressFiltering Enable to filter out incoming media

packets which do not match the expected source IP address and
UDP port. The SG will only accept incoming media packets whose
source address matches the destination address of outbound
packets. When disabled, the filter does not act on the incoming
media stream. The source address to filter on is supplied during
call signaling.
disabled (default)
enabled
mode Specifies the operational mode of this gateway trunk group.
inService
packetOutage The packet outage detection parameters for this
gateway trunk group.
bandwidthLimitReduction Amount to reduce the bandwidth
limit (as a percentage of configured limit) when a packet outage is
detected. (range: 0-100 percent / default = 50)
detectionInterval Size of packet outage detection interval in
minutes. (range: 5-1440 minutes / default = 15)
detectionState Used to enable automatic bandwidth
reduction when a packet outage is detected.
disabled (default) Packet outages are not detected and
maximum bandwidth limit is restored.
enabled Automatic bandwidth reduction will occur when a
packet outage is detected.
minimumCalls Required number of calls with outages within
current interval to declare a packet outage event.
(range: 0-65535 / default = 1000).
minimumDuration Minimum outage (in milliseconds) on a call
for that call to be counted as part of the packet outage detection
algorithm. (range: 0-65535 in milliseconds / default = 6000)
state Administrative state to disable or enable a gateway trunk
group. Select any one of the option:
enabled
disabled (default)

4 79
CLI Reference Guide

Address Context
Zone
h323SigPort
Command Syntax
% set addressContext <name> zone <name> h323SigPort <#>
dscpValue <#>
h225IpAddress <IPv4 address>
h245IpAddress <IPv4 address>
portNumber <#>
Command Parameters
TABLE 4 19 Zone H.323 Signaling Port Parameters
Parameter
Length/
Range Description
zone
1-23
h323SigPort
N/A
The H.323 Signaling Port for this zone.

action Controls whether calls are forced off or allowed to dry up upon a
mode out-of-service. Select any one of the option:
dryup If dryupTimeout is not specified or its value is 0, then no new
calls are accepted and all currently active calls are allowed an indefinite
time period to finish. 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 No new calls are accepted; all active calls are immediately
dropped.
dryUpTimeout Dryup timeout (in minutes) when this H.323 Signaling
Port is outOfService with dryup action. (range: 0-1440 / default = 0).
dscpValue The DSCP value (0-63) for packets from this H.323
Signaling Port. (default = 0).
4 80

CLI Reference Guide

Zone
Address Context
TABLE 4 19 Zone H.323 Signaling Port Parameters (Continued)

Length/
Range Description
Parameter
h323SigPort
(continued)
N/A
h225IpAddress The H.225 IPv4 address of the H.323 Signaling Port.

h245IpAddress The H.245 IPv4 address of the H.323 Signaling Port.
ipInterfaceGroupName The IP interface group to be used by this
Signaling Port.
mode Operational mode for this H.323 Signaling Port.
inService (default)
outOfService
portNumber TCP Port number of the H.323 Signaling Port. (range: 1
65535 / default = 1720).
state Administrative state of the H.323 Signaling Port.
disabled (default)
enabled
h323TrunkGroup
Use this object to configure H.323 trunk group parameters.
NOTE
Command Syntax
% set addressContext <name> zone <name> h323TrunkGroup <TG
name>
cac
bandwidthLimit <0-2147483647, or unlimited>
egress
callBurstMax <1-200>
callRateMax <1-100>
ingress
callBurstMax <1-200>
callRateMax <1-100>

4 81
CLI Reference Guide

Address Context
Zone
callReservationgroup
inbound <1-100>
silc
MC1Percent <0-100>
MC2Percent <0-100>
callRouting
ansSupervisionTimeout <0-1000>
crankBackProfile <name>
respectBearerCapability <disabled|enabled>
media
directMediaGroupId <#>
mediaIpInterfaceGroupName <name>
preAllocateResPad <disabled|enabled>
packetOutage
detectionInterval <5-1440>
policy
callRouting elementRoutingPriority <ERP profile name>
carrier <serving carrier code>
country <country code>
egressDmPmRule <rule>
ingressDmPmRule <rule>
numberingPlan <numbering plan>
4 82

CLI Reference Guide

Zone
Address Context
localizationVariant <generic|japan|northAmerica>
media <packetServiceProfile|toneAndAnnouncementProfile>
services classOfService <COS profile name>
signaling ipSignalingProfile <profile name>
qoe
asr
criticalQosAsrLimit <0-70>
defaultQosAsr <0-100>
majorQosAsrLimit <0-90>
clu criticalQosCluLimit <80-100>
minTimeToProceed <0-3600>
pgrd
criticalQosPgrdLimit <50-10000>
defaultPgrdFactor <50-10000>
rfactor
criticalQosRfactorLimit <0-100>
majorQosRfactorLimit <0-100>
scru criticalQosScruLimit <80-100>
sendingCompleteEnbloc <disabled|enabled>
services
longDurationCall
ldcAction <noAction|release|trap|trapAndRelease>
ldcEmergencyCalls <exclude|include>
ldcRelCause <Q.850 release value>
ldcTimeout <0, 60-2880>
overlapDialing
minDigitsForquery <#>
overlapState <disabled|egressOnly|enabled|ingressOnly>
Command Parameters

4 83
CLI Reference Guide

Address Context
Zone
TABLE 4 20 Zone H.323 Trunk Group Parameters

Parameter
Length/
Range Description
zone
1-23
h323TrunkGroup
N/A
The H.323 trunk groups in this zone. Parameters include:

action Action when putting this H.323 trunk group outOfService.
This object controls whether calls are forced off or allowed to dryup
upon a mode out-of-service.
dryup (default)
force
undefined
cac Call admission control parameters for this H.323 trunk group.
Specify the following CAC parameters:
bandwidthLimit Total media bandwidth limit (in K bits/sec).
bandwidthLimitThreshold Bandwidth limit notification
threshold, as a percentage. (range: 0-100 / default = 0)
callLimit Total number of either ingress or egress concurrent
calls allowed. (range: 0-2147483647, or unlimited).
callLimitThreshold Call limit notification threshold, as a
percentage. (range: 0-100 / default = 0)
4 84

CLI Reference Guide

Zone
Address Context
TABLE 4 20 Zone H.323 Trunk Group Parameters (Continued)

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
egress Egress-specific call admission control configuration.

callBurstMax Maximum allowed burst (above the allowed
sustained rate) for egress call attempts. Enter unlimited or
value in range (1-200) calls/second.
callLimit Total number of concurrent calls (either ingress or
egress) allowed on egress. (range: 0-2147483647, or unlimited /
callRateMax Maximum allowed burst in calls/second (above
the allowed sustained rate) for egress call attempts. (range: 1100, or unlimited).
NOTE: You can set both callBurstMax and CallRateMax as
ingress Specifies the ingress-specific call admission control

configuration. Specify the following ingress parameters:
sustained rate) for ingress calls. Enter unlimited or value in
range of (1-200) calls/second.
callRateMax Maximum sustained ingress call rate allowed
in calls/second. (range: 1-100, or unlimited).

resources for specific call direction or type for this H.323 trunk group.
inbound 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. (range:0-100).
allowed when reservations are enabled for this trunk group. Enter
value in range of 0-128. Default is 1.
priorityCallMinimum Minimum number of priority call
silc The SILC traffic control configuration.
- MC1Percent Percentage of calls to accept when the
machine congestion level is 1. (range: 0-100 / default = 75).
- MC2Percent Percentage of calls to accept when the
machine congestion level is 2. (range: 0-100 / default = 25).
- state Administrative state to enable/disable the SILC traffic
control. Select any one of the option: disabled or enabled.

4 85
CLI Reference Guide

Address Context
Zone

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
4 86
state Administrative state to disable or enable the call

reservation feature on a H.323 trunk group.
callRouting Call routing parameters are listed below.
ansSupervisionTimeout Maximum time (in seconds) from
egress call setup to egress receiving an answer.
(range: 0-1000 / default = 300).
crankBackProfile Name of the crank back profile.
respectBearerCapability Enable flag to accept the Bearer
Capability Information element values unchanged from H.225
SETUP.
- enabled
dryUpTimeout Timeout value (in minutes) for the dry up action.
ingressIpPrefix Ingress peers matching these ingress IP
prefixes are assigned to this H.323 trunk group. Enter IPv4 or IPv6
address in the following format:
IPv4 The V4 IP address in dotted decimal form (for example,
128.127.50.224).
IPv6 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 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 H.323 trunk group. Specify the following media parameters:
directMediaAllowed Enable flag to set up a direct-media path
so that media flows directly between endpoints in the same directmedia group.
- enabled
directMediaGroupId Direct media group to which this trunk
group belongs. (range: 0-65535 / default = 0).
mediaIpInterfaceGroupName Specifies the interface group
to be used for media.
preAllocateResPad This indicates if a resource pad is preallocated or not during an incoming fast start call procedure that
results in G.711 codec selected for the call.
- enabled

CLI Reference Guide

Zone
Address Context

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
sourceAddressFiltering Enable flag to filter out incoming

media packets which do not match expected source IP address
and UDP port.
disabled (default)
enabled
mode Specifies the operational mode of this H.323 trunk group.
inService
packetOutage Packet outage detection parameters for this H.323
trunk group.
limit (as a percentage of configured limit) when a packet outage is
detected. (range: 0-100 / default =50.
detectionInterval The size of the packet outage detection
interval in minutes. (range: 5-1440 / default = 15).
detectionState Enable this flag to perform automatic
bandwidth reduction when a packet outage is detected.
- enabled
minimumCalls The number of calls with outages required within
the current interval to declare a packet outage event.
(range: 0-65535 / default = 1000).
minimumDuration Minimum outage (in milliseconds) on a call
for that call to be counted as part of the packet outage detection
algorithm. (range: 0-65535 / default = 6000).
parentSharedCacLimitsPoolName Name of existing shared
CAC pool.
policy Specifies the policy data for this H.323 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 H.323 trunk group.
country Specifies the parameters and controls used for country
for this H.323 trunk group.

4 87
CLI Reference Guide

Address Context
Zone

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
digitParameterHandling Specifies the parameters and

controls used for digit parameter handling for this trunk group for
this H.323 trunk group. Options are:
- egressDmPmRule The name of the Digit Manipulation/
Parameter Manipulation profile applied at the egress.
- 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 The name of Digit Manipulation/
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
4 88

CLI Reference Guide

Zone
Address Context

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
- numberingPlan 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 Localization variant options for this
H.323 trunk group.
- generic
- japan
- northAmerica
media Parameters associated with media policy for this H.323
trunk group.
- packetServiceProfile Packet service profile name.
- toneAndAnnouncementProfile Tone and announcement
profile name.
services Identifies enhanced services and features for this
H.323 trunk group. Current option:
- classOfService <CoS name>.
signaling SIP signaling for this H.323 trunk group.
- ipSignalingProfile <IPSP name>
qoe Signaling and media Quality of Experience configuration.
asr ASR signaling quality measurement.
criticalQosAsrLimit The critical ASR limit below which
call admission is stopped.
defaultQosAsr Default value used by ASR when no calls
are made during a sampling period (rnage: 0-100 / default = 90).
majorQosAsrLimit The major ASR limit below which call
admission is reduced. (range: 0-90 / default = 70).
clu Call Limit Utilization (CLI) signaling quality measurement.
criticalQosCluLimit Critical limit (in percentage) above
which all calls are dropped on specified peer/trunk group. (range:
80-100 / default = 80).
minTimeToProceed The minimum time period (in seconds)
before call admission starts after any trunk group KPI falls below
the critical threshold. (range: 0-3600 / default = 60).
pgrd Post Gateway Ringing Delay (PGRD) signaling quality
measurement. Options:
criticalQosPgrdLimit The critical PGRD limit (in
milliseconds) above which the call admission is stopped.
(range: 50-10000 / default = 1000).

4 89
CLI Reference Guide

Address Context
Zone

Parameter
h323TrunkGroup
(continued)
4 90
Length/
Range Description
N/A
defaultPgrdFactor Default value to be used as PGRD

when no calls are made for a sampling period.
(range: 50-10000 / default = 1000).
rfactor R-Factor signaling quality measurement.
criticalQosRfactorLimit The critical R-Factor limit
below which call admission is stopped.
majorQosRfactorLimit The major R-Factor limit below
which call admission is reduced. (range: 0-100 / default = 70).
scru Sustained Call Rate Utilization signaling quality
measurement.
criticalQosScruLimit Critical limit (in percentage) above
80-100 / default = 80)
sendingCompleteEnbloc Use this flag to disable/enable
sending a complete called party number in a single enbloc SETUP
message.
disabled (default)
enabled
services Parameters associated with advanced services and
features for this H.323 trunk group.
longDurationCall Defines long duration call supervision.
Parameters include:
ldcAction Action to take if the long duration call timer
expires:
noAction|release|trap|trapAndRelease
ldcEmergencyCalls Flag to include/exclude Emergency
Calls in/from Long Duration Call Disconnect procedures.
- exclude (default)
- include
ldcRelCause Q.850 release value to use should the call be
released due to long duration call timer expiry. (default = 41).
ldcTimeout Timeout value (in minutes) of the long duration
call timer. Options:
- 0 Use to disable the timer (default).
- 60-2880 Sets timer to specified value.
overlapDialing Specifies the Overlap dialing parameters.
minDigitsForQuery Controls the number of called address
digits to collect before performing the first policy query during
overlap receiving. If set to 0, this parameter is irrelevant in
controlling policy query. (Range: 0-30 / default = 0)

CLI Reference Guide

Zone
Address Context

Parameter
h323TrunkGroup
(continued)
Length/
Range Description
N/A
overlapState Control to determine if Overlap Dialing is

supported.
disabled
egressOnly
enabled
ingressOnly
state The administrative state of the H.323 trunk group.
disabled (default)
enabled
id
Command Syntax
% set addressContext <name> zone <name> id <1-2048>
Command Parameters
TABLE 4 21 Zone ID Parameters
Parameter
Length/
Range Description
zone
1-23
id
N/A
Specifies a unique numerical ID for this zone.

(range: 1-2048 / default = 25)
NOTE: Zone ID is unique across all address contexts.

4 91
CLI Reference Guide

Address Context
Zone
ipPeer
Command Syntax
% set addressContext <name> zone <name> ipPeer <peer name>
defaultForIp <false|true>
ipPort <0-65535>
pathCheck
profile <name>
statusUpdateSupport <disabled|enabled>
policy
description <description>
ipSignalingProfile <profile name>
packetServiceProfile <profile name>
sip
fqdn <fqdn>
fqdnPort <0-65535>
sip cacProfile <profile name>
surrogateRegistration
regAuthPassword <DES3 encrypted string>
retryTimer <5-120 mins.>
userPart <user part name>
Command Parameters
TABLE 4 22 Zone IP Peer Parameters
Parameter
Length/
Range Description
zone
1-23
4 92

CLI Reference Guide

Zone
Address Context
TABLE 4 22 Zone IP Peer Parameters (Continued)

Parameter
Length/
Range Description
ipPeer
N/A
Static IP peer name. Parameters include:

defaultForIp Set flag to true to use this peer for the ipAddress and
ephemeral port on ingress.
false (default)
true
ipAddress The IPv4 or IPv6 address of the Peer.
ipPort The TCP/UDP port for this peer.
pathCheck Settings: for options ping:
profile Path check profile name used when pinging this peer.
state Use this flag to enable/disable active pinging.
disabled (default)
enabled
statusUpdateSupport Enable to update the block/unblock state of
SBC 5x00 in the Options ping request.
disabled (default)
enabled
policy Policy parameters and profiles associated with this IP peer.
description IP peer policy description.
ipSignalingProfile The IP signaling profile name.
packetServiceProfile Packet service profile name.
sip Specify SIP fqdn or fqdnPort.
fqdn <string> Specify the FQDN used to send egress calls or
requests to this peer. (max 63 characters).
fqdnPort Specify the FQDN port. (range: 0-65535).
sip SIP parameters for the IP peer.
cacProfile SIP endpoint CAC profile for the IP peer.
(for CAC profile details, see "SIP CAC Profile" on page 7 256).

4 93
CLI Reference Guide

Address Context
Zone

Parameter
ipPeer
(continued)
Length/
Range Description
N/A
surrogateRegistration Configures SBC 5x00 to act as a surrogate

registration entity between a non-registering IP PBX or SIP UA and
REGISTRAR (which mandates registration) for this IP Peer. Do not use
FQDN format when configuring a Surrogate Peer.
When configuring surrogate registration, be sure to set the expires value of
ingress trunk group toward IAD to the maximum default value of 3600.
(see page 4 124). For additional surrogate registration details, please see
the notes below.
regAuthPassword <string> DES3 (triple Digital Encryption
Standard) encrypted string authentication password for surrogate
registration. All ASCII characters from 33 to 126 (except 34 - double
quotes) are allowed. The password is displayed in encrypted form to all
users except user admin. regAuthPassword is optional and needs
configuring only if the Registrar mandates authentication (field length:
24-32 characters).
retryTimer <#> When a Registration or Refresh-Registration for a
peer fails (except 403 message see NOTE below), the retry timer is
initiated. Upon expiry, a new Registration for the peer is
attempted.(range: 5-120 minutes / default = 15 minutes).
state Disables/enables surrogate registration on IP peer.
disabled (default)
enabled
userPart <userpart identity> User part name for the IP-PBX/
SIP UA for which surrogate registration is being enabled. This is a
mandatory parameter. Any character in ABNF format is allowed except
semi-colon ;. (length: up to 127 characters).
Additional notes about Surrogate Registration:

NOTE1: If surrogateRegistration is enabled, you must first disable it before modifying
regAuthPassword, retryTimer or userPart.
NOTE2: The requireRegistration flag must be set to supported-group for the IP Peer on which
surrogate registration functionality is being enabled.
NOTE3: If a 403 Forbidden error response is received in response to Registration/Reregistration for a surrogate IP peer, SBC generates an alarm (listed below) and halts further
registration for this particular IP Peer. The operator must disable/enable the surrogate
registration flag to generate surrogate registration for this IP Peer. The alarm raised is:
sonusSbxSurrRegRegistrationFailedNotification
NOTE4: If Passthrough registration exists for an IP peer on which surrogate registration is
being enabled, the surrogate registration fails and the above alarm is generated. Once
Passthrough registration expires, the operator must disable/enable the surrogate registration
flag to generate surrogate registration for this IP Peer.
Likewise, if surrogate registration exists and Passthrough register is received for the same IP
peer, then Passthrough register is rejected (no alarm is generated - check 403 response for
reason). The operator must disable surrogate registration to allow Passthrough registration to
be successful.
4 94

CLI Reference Guide

Zone
Address Context

Parameter
Length/
Range Description
NOTE5: If RAC limit is set on the trunk group associated with the IP Peer configured for
surrogate registration, you must configure the SIP cause map regTGLimit to point to 503 error
instead of 403.
NOTE6: On enabling surrogateRegistration state of a Peer/Peer's a random timer between 1 sec
to 60 sec is started and Register request will be sent between this timer and not immediately.
This is done to avoid Register avalanche.
NOTE7: SIP Signaling Port must allow transport protocol UDP in order to use surrogate
registration. Surrogate task communicates on UDP with other internal SBC tasks.
NOTE8: If Digest Authentication/Authorization is desired, enable authCodeHeader transparency
on both ingress and egress sip signaling trunk group.
NOTE9: Following a switchover in a redundant system, SBC 5x00 sends a new surrogate
REGISTER for all IP Peers which are reachable and have surrogate registration enabled.
NOTE10: A request from a surrogate peer with a TCP ephemeral (short-lived) port is not
supported.
Command Example
The following examples demonstrate how to configure, enable and disable
surrogate registration.
NOTE
Be sure to issue the commit command after configuring surrogate

peer and before enabling surrogate registration. Otherwise, an error
will occur.
Configure Peer for surrogate registration:
% set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1
ipPeer SURR_PEER1 ipAddress 10.32.241.2 ipPort 12020
surrogateRegistration userPart SURR_REG_PEER1 retryTimer
5 regAuthPassword 123456789012345678901234567890
% commit
Enable surrogate registration:
ipPeer SURR_PEER1 surrogateRegistration state enabled
% commit
Disable surrogate registration:
ipPeer SURR_PEER1 surrogateRegistration state disabled
% commit

4 95
CLI Reference Guide

Address Context
Zone
messageManipulation
Command Syntax
% set addressContext <name> zone <name> messageManipulation
inputAdapterProfile <profile name>
outputAdapterProfile <profile name>
Command Parameters
TABLE 4 23 Zone Message Manipulation Parameters
Parameter
Length/
Range Description
zone
1-23
The name of the zone. You can configure signaling, media, and
control for a zone in the address context.
messageManipulation
N/A
Use this object to assign input and output adapter profiles to this
zone.
inputAdapterProfile The name of the input adapter
profile.
outputAdapterProfile The name of the output adapter
profile.
NOTE: Do not use egressTgName or ingressTgName in
SMM profile defined at the Zone level.
remoteDeviceType
Command Syntax
% set addressContext <name> zone <name> remoteDeviceType
<accessDevice|appServer|none>
4 96

CLI Reference Guide

Zone
Address Context
Command Parameters
TABLE 4 24 Zone Remote Device Type Parameters
Parameter
Length/
Range Description
zone
1-23
remoteDeviceType
N/A
Type of device facing this zone.

accessDevice
appServer
none (default)
sipSigPort
Command Syntax
% set addressContext <name> zone <name> sipSigPort <index #>
dscpValue <#>
ipAddressV4 <IPv4 address>
ipAddressV6 <IPv6 address>
portNumber <#>
recorder <disabled|enabled>
sctpProfileName <name>
tcpConnectTimeout <0-180>
tlsProfileName <name>
transportProtocolsAllowed <sip-sctp|sip-tcp|sip-tlstcp|sip-udp>

4 97
CLI Reference Guide

Address Context
Zone
Command Parameters
TABLE 4 25 Zone SIP Signaling Port Parameters
Parameter
Length/
Range Description
zone
1-23
sipSigPort
1-2048
The Sip Signaling Port for this zone.

dscpValue DSCP value between 0-63 for packets from this SIP
Signaling Port. (default = 0).
ipAddressV4 IPv4 address for this SIP signaling port in dotted
decimal format (for example 128.127.50.224).
ipAddressV6 IPv6 address for this SIP signaling port in
hexadecimal/colon format.
(for example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
ipInterfaceGroupName IP interface group used by this SIP
Signaling Port.
mode Operational mode for this SIP Signaling Port.
inService (default)
outOfService
portNumber UDP/TCP port number of SIP Signaling Port
(default = 5060).
NOTE: If transportProtocolsAllowed is sip-udp, ensure
that portNumber value is outside the configured
mediaPortRange (see Table 8 11) unless portNumber = default
value 5060. If portNumber is other than 5060, user is
prompted to continue with the configuration.
recorder Enable flag to indicate the port is being used for
recording.
disabled (default)
enabled
sctpProfileName SCTP profile name.
state Administrative state of the SIP Signaling Port.
disabled (default)
enabled
tcpConnectTimeout The maximum time (in seconds) allowed for
SBC 5x00 to establish an outbound TCP connection.
tlsProfileName TLS Profile name used by this Signaling Port.
4 98

CLI Reference Guide

Zone
Address Context
TABLE 4 25 Zone SIP Signaling Port Parameters (Continued)

Length/
Range Description
Parameter
transportProtocolsAllowed Transport protocols allowed on

this signaling port:
sip-udp (default) BIT 0
sip-tcp BIT 1
sip-tls-tcp BIT 2
sip-sctp BIT 3
sipSigPort
(continued)
sipTrunkGroup
Use this object to configure SIP trunk groups.
NOTE
Command Syntax
% set addressContext <name> zone <name> sipTrunkGroup <name>
cac
bandwidthLimit <0-2147483647>
callLimit <0-2147483647>
egress
estimatedChildRegistrations <1-256>
ingress
registeredEndpointCacProfile <profile name>
registrationLimit
subscriptionLimit
callReservation
inbound <0-100>
silc
4 99
CLI Reference Guide

Address Context
Zone
MC1Percent <0-100>
MC2Percent <0-100>
callRouting
addStoredPathAsTopRoute <disabled|enabled>
ansSupervisionTimeout <#>
ansSupervisionTimeoutAction <release|trapAndRestart>
crankBackProfile <profile name>
internationalNoaPlus <disabled|enabled>
useRouteSet <disabled|received|stored|storedAll>
congestionHandling
egressThrottling <disabled|enabled>
retryAfterMax <#>
retryAfterMin <#>
downstreamForkingSupport <disabled|enabled>
media
comediaConnectionRole <active|none|passive>
dataPathModePassthru <disabled|enabled>
directMediaAllowedBehindNapt <disabled|enabled>
directMediaGroupId <#>
earlyMedia
forkingBehaviour
<firstProvResponse|lastProvResponse|pemPriority>
method <pEarlyMedia|rtpServerTable|sessionAnswer>
lateMediaSupport <convert|passthru>
maxPtimeDefault <#>
mediaAddrType <iPv4|iPv6|matchSigAddrType>
mediaIpInterfaceGroupName <IPIG name>
pcrf
cushionNullSdp <disabled|enabled>
cushionPacketSize <disabled|enabled>
pcrfCommitment <none|required|supported>
pcrfRealm <DIAMETER domain>
recordable <disabled|enabled>
4 100

CLI Reference Guide

Zone
Address Context
tmr64K <disabled|enabled>
packetOutage
detectionInterval <5/1440>
policy
callRouting elementRoutingPriority <ERP profile name>
carrier <serving carrier code>
country <country code>
egressDmPmRule <rule>
ingressDmPmRule <rule>
numberingPlan <numbering plan>
featureControlProfile <profile name>
ipSignalingPeerGroup <name>
localizationVariant <generic|japan|northAmerica>
media <packetServiceProfile|
toneAndAnnouncementProfile>
services classOfService <COS profile name>
signaling
ipSignalingProfile <profile name>
signalingProfile <profile name>
sipDomain <domain name>
qoe
asr
criticalQosAsrLimit <0-70>
defaultQosAsr <0-100>
majorQosAsrLimit <0-90>
clu
criticalQosCluLimit <80-100>
minTimeToProceed <0-3600>
pgrd
criticalQosPgrdLimit <50-10000>
defaultPgrdFactor <50-10000>
rfactor
4 101
CLI Reference Guide

Address Context
Zone
criticalQosRfactorLimit <0-100>
majorQosRfactorLimit <0-100>
scru
criticalQosScruLimit <80-100>
recordingDNpreference <
fromHeaderOnly|fromHeaderPreferred|toHeaderOnly|toHead
erPreferred>
services
disconnectTreatmentProfile <h323Default|sipDefault>
dnsSupportType <a-only|a-srv-naptr>
dynamicBlacklistProfile <profile name>
emergencyCallHandlingMode <none|rejectWith380>
emergencyCallProfile <profile name>
jsrcBandwidthReservation <disabled|enabled>
longDurationCall
action <noAction|release|trap|trapAndRelease>
emergencyCalls <exclude|include>
relCause <#>
timeoutValue <#>
natTraversal
adaptiveLearning
maxTcpPinholeTimer <60-3600>
maxUdpPinholeTimer <60-600>
reLearningInterval <1-240>
mediaNat <disabled|enabled>
qualifiedPrefix <IPv4 address>
signalingNat <disabled|enabled>
tcpKeepaliveTimer <#>
udpKeepaliveTimer <#>
overlapAddressing
minDigitsForQuery <#>
overlapState <disabled|enabled>
timer2 <#>
timer3 <#>
preconditionIntwkUsing183 <disabled|enabled>
preconditions <none|required|supported>
remoteEPreservation <disabled|enabled>
sipArsProfile <profile name>
sipSecurityProfile <profile name>
transmitPreconditions <none|required|supported>
4 102

CLI Reference Guide

Zone
Address Context
signaling
P-HeaderExtensions
addEgressOrigCa <disabled|enabled>
insertpVisitedNetworkID <identifier>
useIngressOrigCa <disabled|enabled>
TCPFallback
maxMTUSupportedOverUDPControl <disabled|enabled>
maxMTUSupportedOverUDPValue <1-5000>
X-Headers
HeaderFlag <none|xHeaders>
acceptHistoryInfo <disabled|enabled>
allowByeChallenge <disabled|enabled>
backwardInfoMsgConDialog <disabled|enabled>
callingParty
cpcParamFromHeader <default|fromheader|paitel>
fromHdrForCallingParty <disabled|enabled>
paiForCallingParty <disabled|enabled>
ppiForCallingParty <disabled|enabled>
rpiForCallingParty <disabled|enabled>
trustedSourceForIsup <disabled|enabled>
causeCodeMapping
cpcSipCauseMappingProfile <profile name>
sipCpcCauseMappingProfile <profile name>
sipInternalCauseMappingProfile <profile name>
useNonDefaultCauseCodeforARSBlackList
<enabled|disabled>
condIncMethInAllowHdr <disabled|enabled>
deRegParentWithChildDereg <disabled|enabled>
defaultCallingPartyNumber <default calling number>
disableTermIOIForPcscf <disabled|enabled>
egressCallIdStaticString <string>
enforceSipsIfEgressIsTls <disabled|enabled>
enforceTlsIfSipsUriScheme <disabled|enabled>
factorValue <value>
interOperatorID <identifier>
isubParamPreference <nonstandard|rfc2806|rfc3966>
isupMimeBodyRelay <disabled|enabled>
localNumberSupport <disabled|enabled>
maxFwdsDefault <value>
messageManipulation
4 103
CLI Reference Guide

Address Context
Zone
includeAppHdrs <disabled|enabled>
inputAdapterProfile <name>
outputAdapterProfile <name>
methods
info <allow|reject>
message <allow|reject>
notify <allow|reject>
options <allow|reject>
publish <allow|reject>
refer <allow|reject>
register <allow|reject>
subscribe <allow|reject>
update <allow|reject>
ocsSupport <disabled|enabled>
privacyParamRestricted <default|idonly>
psxRouteForSubscribe <disabled|enabled>
registration
bulkRegisterFormat <disabled|enabled|followIngress>
expires <#>
includeXOriginalAddr <disabled|enabled
insideExpiresMinimum <#>
requireRegistration <none|required|requirednonpriority|supported|supported-group>
rel100Support <disabled|enabled>
relayNonInviteRequest <disabled|enabled>
relayReplacesHeader <disabled|enabled>
retryCounters
bye <max # retransmissions for BYE>
cancel <max # retransmissions for CANCEL>
general <max # retransmissions for generic>
invite <max # retransmissions for INVITE>
invite200 <max # retransmissions for 200 OK for
initial INVITE>
reInvite <max # retransmissions for re-INVITE>
retryOn422 <max # session keepalives on 422>
retryOn491 <max # session keepalives on 491>
routeMsgValidation < noValidation|sipI|sipOnly>
sdpTransparency
sdpTransparencyState <disabled|enabled>
sourceAddressValidation <disabled|enabled>
strictParse <disabled|enabled>
4 104

CLI Reference Guide

Zone
Address Context
timers
ocsDialogTimer <# seconds>
sctpRetransmitTimer <# seconds>
sessionKeepalive <# seconds>
sessionMinSE <# seconds>
sessionTerminationDeltaTime <# seconds>
suspendResumeTimer
type <both|networkTypeOnly|userTypeOnly>
value <#>
t1 <# milliseconds>
t2 <# milliseconds>
tcpRetransmitTimer <# seconds>
transportPreference
preference1 <none|sctp|tcp|tls-tcp|udp>
uriPreference <none|sip|tel>
usePSXRouteAsReqUriInReg <disabled|enabled>
usePsxRouteForEmergencyCall <disabled|enabled>
validateAor <disabled|enabled>
variantType <mgcf|q1912|sonus|ttc|uk>
ucidSupport <none|passthruOrGenerate>

4 105
CLI Reference Guide

Address Context
Zone
Command Parameters
TABLE 4 26 Zone SIP Trunk Group Parameters
Parameter
Length/
Range Description
zone
1-23
sipTrunkGroup
N/A
The SIP trunk groups for this zone. SIP trunk group parameters include:
action Action when putting this SIP trunk group outOfService. This
action controls whether calls are forced off or allowed to dryup upon a
mode out-of-service action.
dryUp (default)
force
cac Call (and registration) admission control parameters for this SIP
trunk group. Options are:
bandwidthLimit The total media bandwidth limit (in Kbits/sec).
bandwidthLimitThreshold Bandwidth utilization notification
threshold as a percentage. (range: 0-100 / default = 0)
egress) allowed. (range: 0-2147483647, or unlimited / default is
unlimited).
callLimitThreshold Call Limit utilization notification
threshold, as a percentage. (range: 0-100 / default = 0).
egress Egress-specific call admission control configuration for
the SIP trunk group.
callBurstMax Maximum allowed burst size (above the
allowed sustained rate) for egress call attempts, in calls per
second. (range: 1-200, or unlimited / default is unlimited)
egress) allowed on egress. (range: 0-2147483647, or unlimited /
callRateMax Maximum sustained egress call rate allowed in
calls per second. (range: 1-100, or unlimited / default is
unlimited).
4 106

CLI Reference Guide

Zone
Address Context
TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A

emergencyOversubscription Oversubscription of
resources (as a percentage) that is allowed for emergency calls.
(range: 0-1000 / default = 10).
otherReqBurstMax Maximum allowed burst (above the
allowed sustained rate) for any other egress out-of-dialog SIP
request. (range: 1-1000, or unlimited / default is unlimited)
otherReqRateMax Maximum sustained egress rate (requests
per second) of other out-of-dialog SIP requests. (range: 1-1000,
or unlimited / default is unlimited)
registerBurstMax Maximum allowed burst (above the
allowed sustained rate) for egress initial SIP registrations. (range:
registerRateMax Maximum sustained egress rate
(registrations per second) of initial SIP registrations allowed.
NOTE: You can set both registerBurstMax and
registerRateMax as unlimited; however, if you assign a value
to one parameter, the other must also be assigned a value.
subscribeBurstMax Maximum allowed burst (above the

allowed sustained rate) for egress initial SIP subscribe request.
subscribeRateMax Maximum sustained egress rate
(subscribes per second) of initial SIP subscribe request. (range:
emergencyOversubscription Oversubscription of resources
(as a percentage) that is allowed for emergency calls.
(range: 0-1000 / default = 10).
estimatedChildRegistrations Estimated number of child
registrations (i.e., the estimated number of P-Associated-URIs in
200 OK. (range: 1-256 / default = 1).
ingress Ingress-specific call admission control configuration for
the SIP trunk group.
sustained rate) for ingress calls in calls per second.
callLimit Total number of concurrent calls allowed on
ingress. (range: 0-2147483647, or unlimited / default is
unlimited).

4 107
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
callRateMax Maximum sustained ingress call rate allowed in

calls/second. (range: 1-100, or unlimited / default is unlimited).
emergencyOversubscription Oversubscription of
resources (as a percentage) that is allowed for emergency calls.
(range: 0-1000 / default = 10).
otherReqBurstMax Maximum allowed burst (above the
allowed sustained rate) for any other ingress out-of-dialog SIP
request. (range: 1-1000, or unlimited / default is unlimited)
otherReqRateMax Maximum sustained ingress rate (requests
per second) of other out-of-dialog SIP requests. (range: 1-1000,
or unlimited / default is unlimited)
registerBurstMax Maximum allowed burst (above the
allowed sustained rate) for initial SIP registrations. (range: 11000, or unlimited / default is unlimited)
registerRateMax Maximum sustained rate of initial SIP
registrations allowed in registrations per second. (range: 1-1000,
or unlimited / default is unlimited).
registerRateMax as unlimited; however, if you assign a value
to one parameter, the other must also be assigned a value.
4 108
subscribeBurstMax Maximum allowed burst (above the

allowed sustained rate) for ingress initial SIP subscribe request.
subscribeRateMax Maximum sustained ingress rate
(subscribes per second) of initial SIP subscribe request. (range:
registeredEndpointCacProfile Endpoint CAC profile
containing CAC parameters that are applied individually to each
registrant.
registrationLimit The total number of concurrent SIP
registrations allowed. (range: 0-2147483647, or unlimited / default is
unlimited)
subscriptionLimit The total number of concurrent SIP
subscriptions allowed on IP trunk group. (range: 0-2147483647, or
unlimited / default is unlimited).

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A

resources for specific call direction or type for this SIP trunk group.
inbound The percentage of callLimit reserved for handling
inbound calls. Enter value in 5 percent increments.
allowed when reservations are enabled. (range: 0-128 / default = 1)
allowed when reservations are enabled.
priorityCallMinimum Minimum number of priority call allowed
when reservations are enabled.
silc Specifies the SILC traffic control configuration.
MC1Percent Specifies the percentage of calls to accept when
the machine congestion level is 1.
MC2Percent Specifies the percentage of calls to accept when
the machine congestion level is 2.
state Use flag to enable/disable SILC traffic control.
- enabled
state Administrative state to disable or enable the call
reservation feature on a SIP trunk group.
disabled (default)
enabled
callRouting Specifies the parameters and controls used for
routing a call or request to the next-hop entity for this SIP trunk group.
addStoredPathAsTopRoute When enabled, adds the stored
Path header as the topmost Route header (on top of stored ServiceRoute headers) in the outgoing out-of-dialog requests when
useRouteSet is set to stored.
disabled (default)
enabled
ansSupervisionTimeout This is the maximum time (in
seconds) from egress call setup to egress receiving an answer.
(default = 300).
ansSupervisionTimeoutAction Action to take if the answer
supervision timer expires.
release (default)
trapAndRestart

4 109
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
4 110
Length/
Range Description
N/A
crankBackProfile Crankback profile name.

internationalNoaPlus Enable flag to set CPN and CIN NOA
to International when number begins with '+'.
disabled (default)
enabled
useRouteSet This parameter controls the routeset usage when
routing a call.
disabled (default) Request is routed using routing database.
received Request is routed using the received routeset in the
request.
stored Request is routed using Path or Service-Route stored
during registration.
storedAll All requests (including refresh registers) are routed
using Path or Service-Route stored during registration.
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) The traffic rate allowed to this peer is
unchanged when a 503 response is received from the peer.
enabled Traffic rate allowed to this peer is decreased when a
503 response is received from the peer.
retryAfterMax Maximum Retry-After time (in seconds) when
an ingress call or register is rejected with 503 due to local overload.
(default = 30).
retryAfterMin Minimum Retry-After time (in seconds) when an
ingress call or register is rejected with 503 due to local overload.
(default = 10).
downstreamForkingSupport The flag which indicates if the down
stream forking is supported.
disabled (default)
enabled
dryUpTimeout The timeout value in minutes for the dry up action.
Enter the value between 1-1440 minutes. Default is 5.

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
ingressIpPrefix The ingress peers matching these ingress IP

and prefix will be assigned to this SIP trunk group. Enter IPv4 or IPv6
address in the following format:
IPv4 Specifies the V4 IP address in dotted decimal form (for
example 10.11.12.0 24).
IPv6 The V6 IP address in hexadecimal/colon form (for example,
fd00:21:445:128::7880 64).
prefixLength 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.
dataPathModePassThru Specifies whether the SBC will
transpass media direction (Data Path Mode) received from a peer in
the Offer SDP RTP IP.
disabled (default)
enabled
directMediaAllowed If enabled, attempt to set up a directmedia path so that media flows directly between endpoints in the
same direct-media group.
disabled (default)
enabled
directMediaAllowedBehindNapt If enabled, attempt to set
up a direct-media call for endpoints behind NAT.
disabled (default)
enabled
directMediaGroupId This identifies the direct media group to
which this trunk group belongs.(range: 0-65535 / default = 0).

4 111
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
earlyMedia Specifies the parameters associated with early

Media support. (see Table 4 27 on page 4 129 for a full
explanation of Early Media parameters).
forkingBehaviour Use this object to identify the method to
provide early dialog media selection.
method Method used to provide early media.
lateMediaSupport Determines whether a SIP late media
(reverse offer) INVITE should be converted to a forward offer on
egress or else allowed to transparently pass through.
convert (default)
passthru
maxPtimeDefault This field indicates the default packet size in
milliseconds. (default = 150).
mediaAddrType The Media Address Type attribute determines
the type of IP address used in the offer. The possible values are
iPv4, iPv6 and matchSigAddrType.
mediaIpInterfaceGroupName Name of the IP interface group
for media.
pcrf Use this object to define Policy and Charging Rules
Function (PCRF) parameters.
cushionNullSdp Enable flag to allow AAR when initial call
setup is an INVITE which lacks SDP (estimate G.711 10 msec as
a worst case). Disable flag to wait for reverse offer.
- enabled
cushionPacketSize Enable flag to use the smallest packet
size in an answer from the range supported for each codec for
bandwidth estimate.Disable flag to use packet size in offer.
- enabled
NOTE: Enabling this option may avoid rejecting an answer
because its AAR fails even though the offer AAR succeeds, and
also to abort a call after ringing the destination.
pcrfCommitment The degree of commitment expected from
the PCRF during call setup or call update.
- none (default) Do not send AAR.
- required Send AAR; proceed only if it succeeds.
- supported Send AAR; proceed even if it fails.
pcrfRealm The DIAMETER domain of a Policy and Charging
Rule Function (up to 127 characters).
4 112

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
recordable Enable flag to support media recording of RTP

stream to an external recording device on this SIP trunk group.
disabled (default)
enabled
sourceAddressFiltering When enabled, incoming media
packets which do not match the expected source IP address and
UDP port are filtered out.
disabled
enabled (default)
tmr64K Enable this flag to allow the transmission Medium
Requirement Unrestricted 64kbit/s control for SIP-ISUP
interworking.
disabled (default)
enabled
mode The operational mode for this SIP trunk group.
inService
packetOutage Specifies the packet outage detection parameters
for this SIP trunk group.
limit (as a percentage of the configured limit) when a packet outage
is detected. (range: 0-100 / default = 50).
detectionInterval Size of the packet outage detection
interval in minutes. (range: 5-1440 / default = 15).
detectionState Use to enable automatic bandwidth reduction
when a packet outage is detected.
minimumCalls Number of calls with outages required within the
current interval to declare a packet outage event. Must be 0-65535.
Default is 1000.
minimumDuration The minimum outage (in milliseconds) on a
call for that call to be counted as part of the packet outage detection
algorithm. Must be 0-65535 in milliseconds. Default is 6000
milliseconds.
parentSharedCacLimitsPoolName Existing shared CAC pool.
policy Policy data for this SIP trunk group.
callRouting Route a call or request to the next-hop entity.
elementRoutingPriority Element Routing Priority Profile
name.
carrier The serving carrier code.
country Serving country code.

4 113
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
4 114
Length/
Range Description
N/A
digitParameterHandling Used for digit parameter handling

for this trunk group for this trunk group.
egressDmPmRule The name of Digit Manipulation and
Parameter Manipulation profile applied at the egress.
- 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 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

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
numberingPlan 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 Select the profile associated with media policy for this SIP
trunk group.
toneandAnnouncementProfile
services The service associated with various enhanced
services and features for this SIP trunk group.
classOfService <CoS profile name>
signaling Identifies the parameters controlling the specifics of
the SIP signaling for this SIP trunk group.
ipSignalingProfile IP Signaling Profile name.
signalingProfile Signaling Profile name.
sipDomain The domain string used when SIP signaling requires
a configured domain name.
qoe Signaling and media Quality of Experience configuration.
asr ASR signaling quality measurement.
criticalQosAsrLimit The critical ASR limit below which
call admission is stopped.
defaultQosAsr Default value used by ASR when no calls are
made during a sampling period (rnage: 0-100 / default = 90).
majorQosAsrLimit The major ASR limit below which call
admission is reduced. (range: 0-90 / default = 70).
clu Call Limit Utilization (CLI) signaling quality measurement.
criticalQosCluLimit Critical limit (in percentage) above
80-100 / default = 80).
minTimeToProceed The minimum time period (in seconds)
before call admission starts after any trunk group KPI falls below the
critical threshold. (range: 0-3600 / default = 60).

4 115
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
4 116
Length/
Range Description
N/A
pgrd Post Gateway Ringing Delay (PGRD) signaling quality

measurement.
criticalQosPgrdLimit The critical PGRD limit (in
milliseconds) above which the call admission is stopped.
(range: 50-10000 / default = 1000).
defaultPgrdFactor Default value to be used as PGRD
when no calls are made for a sampling period.
(range: 50-10000 / default = 1000).
rfactor R-Factor signaling quality measurement.
criticalQosRfactorLimit The critical R-Factor limit below
which call admission is stopped.
majorQosRfactorLimit The major R-Factor limit below
which call admission is reduced. (range: 0-100 / default = 70).
scru Sustained Call Rate Utilization signaling quality
measurement.
criticalQosScruLimit Critical limit (in percentage) above
80-100 / default = 80)
recordingDNpreference Select an option below to set
recordingDN matching preferences.
fromHeaderOnly (default) Use only From header when
performing recordingDN matching.
fromHeaderPreferred From header is used before To header
for recordingDN matching.
toHeaderOnly Use only To heder when performing recordingDN
matching
toHeaderPreferred To header is used before From header for
recordingDN matching.
services The parameters associated with various enhanced
services and features for this SIP trunk group.
disconnectTreatmentProfile Disconnect Treatment Profile
name.
dnsSupportType Indicates 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, a-srv-naptr.
dynamicBlacklistProfile Dynamic Blacklist Profile name.
emergencyCallHandlingMode Use this parameter to specify
how to handle emergency calls.
none (default) Use this option (and check that
usePsxRouteForEmergencyCall is enabled) to perform PSX dip
for registered user for emergency call.
rejectWith380 Use this option to reject an INVITE request
with 380 Alternate Service response code from Ingress leg when
the request is identified as emergency request and redirection
flag is set to redirection mode.

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
emergencyCallProfile Emergency Call Profile name.

longDurationCall The parameters associated with long
duration call supervision.
action This is the action to take if the long duration call timer
expires.
- noAction (default)
- release
- trap
- trapAndRelease
emergencyCalls Specifies whether Emergency Calls should
be excluded from or included in Long Duration Call Disconnect
procedures.
- exclude (default)
- include.
relCause The Q.850 release value to use should the call be
released due to long duration call timer expiry. (default = 41).
timeoutValue Timeout value (in minutes) of the long duration
call timer. Supported values: 0 to disable the timeout, 1- 44640 to
set the timeout to the specified value. (default = 0).
natTraversal Specifies the various parameters associated with
network-hosted NAT/NAPT traversal for SIP endpoints. Specify the
following NAT Traversal parameters.
adaptiveLearning Adaptive NAT pinhole learning
parameters.
- maxTcpPinholeTimer Defines upper limit of the pinhole
timeout for TCP in seconds. (range: 60-3600 / default = 600).
- maxUdpPinholeTimer Defines the upper limit of the pinhole
timeout for UDP in seconds. (range: 60-600 / default = 180).
- reLearningInterval Interval in hours at which the pinhole
timeout is relearned. (range: 1-240 / default = 24).
- state Enables/disables the adaptive nat pinhole timeout
learning process for devices behind NAT.
-- disabled (default)
-- enabled
mediaNat Specifies the whether or not NAT/NAPT support is
required for media.
- enabled
qualifiedPrefix Set of IP network media and signaling
prefixes that an address must match to be considered for NAT
handling. If there are no entries in qualifiedPrefix table, the
endpoint is treated as existing behind a NAT device. As a result,
SBC 5x00 will consider requests from all IP addresses to be
behind a NAT device.

4 117
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
4 118
Configuration options include:

- ipAddress IPv4 or IPv6 address.
- prefixLength Value from 0-128 specifying the number of
bits representing the network part of ipAddress.
signalingNat This indicates whether or not NAT/NAPT
support is required for signaling.
- enabled
tcpKeepaliveTimer The NAT keepalive timer (in seconds)
for SIP over TCP. (default = 240).
udpKeepaliveTimer The NAT keepalive timer (in seconds)
for SIP over UDP. (default = 60).
overlapAddressing Parameters associated with overlap
addressing support.
minDigitsForQuery Minimum number of digits that need to
be received before attempting to route the call.
(default = 0).
overlapState Specifies the whether to support or not support
overlap addressing.
- enabled
timer2 Maximum time (in seconds) between sending an
INVITE and receiving a backward message. (default = 0).
timer3 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 = 4).
preconditionIntwkUsing183 Enable this flag to locally
generate first 183 responses for preconditions interworking. If
disabled, these responses are dropped.
disable (default)
enable
preconditions Indicates level of preconditions support.
none (default)
required
supported
sipArsProfile The name of the SIP ARS (Address
Reachability Service) profile.
sipSecurityProfile The name of the SIP Security Profile.
transmitPreconditions Indicates level of preconditions
support for outgoing request/response.
none
required
supported (default)

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
signaling The parameters controlling SIP signaling details.

P-HeaderExtensions Prescribed behavior associated with
various 3GPP P-Headers.
addEgressOrigCa Enable to send P-Orig-CA header on the
egress side.
- enabled
insertpVisitedNetworkID Use this parameter to set the PVisited-Network-ID header value when receiving REGISTER,
OOD INVITE and OOD non-INVITE requests from UE before the
message is forwarded towards IMS core network (for example,
visitedNetwork or \Visited Network\). (range: 1-255 characters)
useIngressOrigCa Enable to honor P-Orig-CA header
received on the ingress side.
- enabled
TCPFallback Use this control to configure TCP Fallback
settings.
maxMTUSupportedOverUDPControl Maximum MTU Size
accepted over UDP.
- enabled
maxMTUSupportedOverUDPValue Maximum size of the SIP
Invite accepted over UDP.
(range: 1-5000 / default = 1300).
X-Headers Controls the X and P Header behavior applicable to
this trunk group.
HeaderFlag Select header type allowed on SIP trunk group.
- none (default)
- xHeaders
acceptHistoryInfo Enable this flag to accept History-Info
header received on the ingress trunk group.
disabled (default)
enabled

4 119
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
allowByeChallenge This flag enables the Bye-Challenge

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.
disabled. (default)
enabled
backwardInfoMsgConDialog If enabled, an INFO message
will only be sent after confirmed Dialog.
disabled (default)
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.
- default (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.
- disabled
- enabled (default)
paiForCallingParty If enabled, the PAI header (if present)
will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
ppiForCallingParty If enabled, the PPI header (if present)
- disabled
- enabled (default)
rpiForCallingParty If enabled, the RPI header (if present)
- disabled
- enabled (default)
NOTE: Both ppiForCallingParty and rpiForCallingParty options

are not applicable in Q.1912.5 SIP-I to SIP-I scenarios. Based on
the Q.1912.5 recommendation, the mapping to calling party
number only occurs if a PAI header containing valid address
digits (0-9) are received.
trustedSourceForIsup Used to indicate if the message
came from a trusted source and the FROM header can be used
to map into ISUP parameters.
- disabled
- enabled (default)
4 120

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
causeCodeMapping Controls the mapping of CPC cause codes

to/from SIP cause codes. Specify the following parameters.
cpcSipCauseMappingProfile The name of the CPC to SIP
cause mapping profile. Select any one of the option:
defaultCpcSip, defaultQ1912CpcSip,
defaultRFC3398CpcSip, defaultTs29163CpcSip.
sipCpcCauseMappingProfile The name of the SIP to CPC
cause mapping profile. Select any one of the option:
defaultQ1912SipCpc, defaultRFC3398SipCpc,
defaultSipCpc, defaultTs29163SipCpc.
sipInternalCauseMappingProfile The name of internal
cause to SIP cause mapping profile.
useNonDefaultCauseCodeforARSBlackList Enable flag
to use cause code 168 for route rejection due to ARS blacklisting.
- enabled
condIncMethInAllowHdr Enable this flag to use ingress
message ALLOW header content in the egress message. Only
methods which are configured as allowed at the egress TG are
populated from ingress to the egress message. Methods with no
configuration present are considered allowed (example: INVITE).
disabled (default)
enabled
deRegParentWithChildDereg Enable this flag to allow PCSCF to delete parent RCB and all its childs during de-registration
of any of the child IP Multimedia Public Identities (IMPUs).
disabled (default)
enabled
defaultCallingPartyNumber <string> The default calling
number for Caller Privacy feature. If the party number is configured
and the flag mslyncprivacysupport is enabled, the configured
number is inserted as the user name of either the from header or
the P-Asserted-Identity fields depending on the configuration.
(maximum 15 characters)
disableTermIOIForPcscf Enable this flag to prevent P-CSCF
from adding erm-ioi parameter to any requests while creating PCharging-Vector (PCV) header.
disabled (default)
enabled
egressCallIdStaticString String for generating the egress
callid when configured option for egressCallIdType in PSX is "Use
Static String". (default is a hyphen -). Egress Call-id is the
aggregate of Ingress Call-id and locally generated string in SBC.

4 121
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
4 122
enforceSipsIfEgressIsTls Enable this flag to change the

URI scheme as described below.
disabled (default) If flag is disabled at AS side, SBC uses SIP
URI scheme. If disabled at IAD side, SBC sets the URI scheme of
any header using sips:, as SIPS.
enabled If flag is enabled at AS side, SBC enforces SIPS URI
scheme in Request-Uri and Contact Header if request is
egressed using TLS as transport. If enabled at IAD side, SBC
sets the URI scheme of any header using sips:, as SIPS.
enforceTlsIfSipsUriScheme Enable this flag to enforce
using TLS to egress a request if the Request-URI/topmost Route
header uses sips scheme on a per-peer group basis.
disabled (default) If flag is disabled at AS side, SBC uses SIP
URI scheme.If disabled at IAD side, SBC sets the URI scheme of
any header using sips:, as SIPS.
enabled If flag is enabled at AS side, SBC enforces the use of
TLS for egressing any dialog initiating request if incoming request
has SIPS URI scheme in either Request-Uri or top-most NonNBS Route Header. If enabled at IAD side, SBC sets URI scheme
of any header using sips:, as SIPS.
factorValue Enter the factor value to use to interwork the SIP
Max-Forwards header and the ISUP Hop counter parameter.
(default = 1).
interOperatorID (ioi) A globally unique identifier shared
between sending and receiving networks. Specify the ioi for MGCF
(up to 23 characters).
isubParamPreference This trunk group attribute specifies how
the ISDN Sub-Address parameter is handled in SIP.
nonstandard When receiving, treat the percentage character
(%) as an escape character. When sending, do not include
characters not allowed by certain proxies.
rfc2806 (default) Use for default behavior when handling
ISUB parameter.
rfc3966 Encode/decode the ISUB parameter based on the
ABNF for ISUB specified in RFC3966.
isupMimeBodyRelay Enable flag to transparently relay (in
egress SIP signaling) an ISUP mime body received in SIP signaling.
When disabled, ISUP mime bodies are decoded and interworked
based on the egress signaling configuration.
disabled (default)
enabled
localNumberSupport Enable this flag to allow P-CSCF to
globalize To hdr in Register,req URI in SUBSCRIBE for regevt and
perform a PSX dip for non-INVITE for tel URI as well as control the
dial string feature.
disabled (default)
enabled
CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
maxFwdsDefault Default value for the Max Forwards Header.

(default = 70).
messageManipulation Provides options to manipulate SIP
header content. Options include:
includeAppHdrs Enable flag to allow Application to add
headers in outgoing messages.
- enabled
inputAdapterProfile Input Adapter Profile name.
outputAdapterProfile Output Adapter Profile name.
methods Use this object to allow or reject various SIP methods as
indicated below.
info Determines if INFO method is included in the Allow
header.
- allow (default)
- reject
message Determines if MESSAGE request is accepted and
processed or rejected with 405 message
- allow (default)
- reject
notify Determines if NOTIFY request is accepted and
processed or rejected with 405.
- allow (default)
- reject
options Determines if OPTIONS request is accepted and
- allow (default)
- reject
publish Determines if PUBLISH request is accepted and
- allow (default)
- reject
refer Determines if REFER request is accepted and
- allow (default)
- reject
register Determines if REGISTER method is included in the
Allow header.
- allow (default)
- reject
subscribe Determines whether SUBSCRIBE request is
accepted and processed or rejected with 405.
- allow (default)
- reject

4 123
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
update Determines whether UPDATE request is accepted and

- allow (default)
- reject
ocsSupport Enable this flag to enable OCS (Office
Communications Server, a.k.a MS Lync) support.
disabled (default) CSTA invites are rejected with 415
Unsupported Media Type error message.
enabled Relays CSTA invites to the far side.
privacyParamRestricted Use this object to define SIP
Privacy header parameter mapping (incoming to outgoing call).
default (default) Map Privacy header parameters, ID, or user
to restrict.
idonly Only map Privacy header parameter ID to restrict.
psxRouteForSubscribe Enable this flag to use PSX routes for
routing the SUBSCRIBE to registered users.
disabled (default)
enabled
registration Defines the parameters controlling registration
relay behavior.
bulkRegisterFormat Use this flag to determine how the
registration requests are formatted with respect to RFC 6140.
- disabled (default) REGISTER message is not formatted as
per RFC 6140.
- enabled REGISTER message is formatted as per RFC
6140.
- followIngress No changes are made to the Egress
Register with respect to RFC 6140.
expires The time (in seconds) a SIP endpoint's registration
session lasts before requiring re-registration. (default = 3600).
This value does not apply if the endpoint is NAT'd.
includeXOriginalAddr Enable this flag to insert the X
Original Addr header into REGISTER message.
- enabled
insideExpiresMinimum Controls the initial expire value (in
seconds) in a REGISTER relayed to a registrar. (default = 3600).
NOTE1: Since the SBC 5x00 expects an expires value greater
than 480 seconds (8 minutes) from the registrar, do not set
insideExpiresMinimum value less than 480 seconds. Ideally,
set this value much higher (3600 seconds is recommended) to
avoid overloading registrar with register refreshes.
NOTE2: When configuring surrogate registration (see page 4
94), be sure to set the expires value of ingress trunk group
toward IAD to the maximum default value of 3600.
4 124

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
requireRegistration Use this flag to specify the type of

endpoint registration validation required.
- none (default) No registration validation is required.
- required Prevent unregistered IADs from making or
receiving any calls.
- required-nonpriority Prevent unregistered IADs from
making or receiving non-priority calls. Since priority calls are
exempt, unregistered endpoints are still allowed to make priority
calls.
- supported Accept registrations from unregistered endpoints
when the associated trunk group is used for endpoints optionally
requiring registration. If an endpoint is registered, then the
registration data is used to send calls to that endpoint instead of
PSX route.
- supported-group Accept registrations from unregistered
users and from users whose user names do not match with the
stored URI in Registration Control Block. If an endpoint is
registered, then the registration data is used to send calls to that
endpoint instead of PSX route.
NOTE: Set requireRegistration flag to supported-group for the
IP Peer on which surrogate registration functionality is being
enabled.
rel100Support Enable to allow option tag 100rel support for the

reliability of provisional messages as specified in RFC3262.
disabled
enabled (default)
relayNonInviteRequest Enable this flag to relay non-Invite
requests.
disabled (default)
enabled
NOTE: Use relayNonInviteRequest flag for unregistered users

only.
relayReplacesHeader When enabled, P-CSCF relays

Replaces header with INVITE.
disabled Process INVITE locally.
enabled (default) Translate dialog identifier and relay
Replaces header in INVITE.
retryCounters Retry counter values for various SIP request
types.
bye Maximum number of retransmissions for SIP BYE request.
cancel Maximum number of retransmissions for SIP CANCEL
request. (range: 0-12 / default = 3).

4 125
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
4 126
general Maximum number of retransmissions for generic SIP

invite Maximum number of retransmissions for SIP INVITE
invite200 Maximum number of retransmissions for the 200
OK for initial SIP INVITE request. (range: 0-10 / default = 0)
reInvite Maximum number of retransmissions for SIP ReINVITE request. (range: 0-6 / default = 3).
retryOn422 Maximum number of session keepalive
negotiations upon receiving 422. (range: 0-12 / default = 5)
retryOn491 Maximum number of session keepalive
negotiations upon receiving 491. (range: 0-12 / default = 5)
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. The call is released after
invalidation if an invalid message type is received.
noValidation (default)
sipI Route validation on received messages for SIP-I.
sipOnly Route validation on received messages for SIP-only
messages.
sdpTransparency SDP Transparency control to set the
sdpTransparencyState flag to transparently pass SDP information.
sdpTransparencyState Enabling this flag on both legs will
transparently pass SDP information.
- enabled
sourceAddressValidation Enable this flag to support source
address validation so that messages coming from a different IP
address or port than expected are not allowed.
disabled (default)
enabled
strictParse Enables this flag to reject requests which are
understandable, but violate the relevant RFC Augmented BackusNaur Form (ABNF) production rule.
disabled (default)
enabled
timers Use this object to define retransmission and session
keep-alive timer parameters.
ocsDialogTimer This relay control block timer is restarted for
each relay request received. If no request is received for the
configured period, the dialog is deleted. When the timer is set to
0, sessionKeepalive flag is disabled. (range: 0-10080 / default =
1440 minutes).

CLI Reference Guide

Zone
Address Context

Parameter
sipTrunkGroup
(continued)
Length/
Range Description
N/A
sctpRetransmitTimer The retransmit timer (in seconds) for

SIP request over SCTP. (default = 6).
sessionKeepalive The SIP protocol session keep-alive
timer (in seconds). (range: 0-65535 / default = 1800).
sessionMinSE Minimum expiration value (in seconds)
accepted from a Session-Expires header (range: 0-65535 /
default = 90).
sessionTerminationDeltaTime The time (in seconds)
before session expiration at which the SBC 5x00 sends a BYE if
no session refresh request is received. This only applies when
acting as the session keepalive responder (i.e. not refresher) for a
call. (range: 0-65535 / default = 0).
suspendResumeTimer If enabled, this timer starts counting
when SUSPEND ISUP message is received in SIP MIME. The
timer is cancelled upon receipt of RESUME ISUP message.
- state Administrative state of timer (default is disabled)
- value The suspend-resume timer value, in seconds.
- type Type of ISUP message to apply timer against.
-- userTypeOnly
-- networkTypeOnly
-- both (default)
t1 This is the SIP protocol retransmission timer T1 (in
milliseconds). T1 is an estimate of the round-trip time (RTT).
(range: 1-10000 / default = 500).
t2 This is the SIP protocol timer T2 (in milliseconds), and
represents the maximum retransmit interval for non-INVITE
requests and INVITE responses. (range: 1-65535 / default =
4000).
tcpRetransmitTimer The retransmit timer (in seconds) for
SIP request over TCP. (range: 0-15 / default = 6).
transportPreference Use this object to define the preference
ordering of allowed SIP transports.
preference1
preference2
preference3
preference4
For each of the above parameters, choose an option below:
none (default)
sctp
tcp
tls-tcp
udp

4 127
CLI Reference Guide

Address Context
Zone

Parameter
sipTrunkGroup
(continued)
4 128
Length/
Range Description
N/A
uriPreference Use this object to define URI presentation

preference for outgoing messages.
none (default)
sip
tel
usePSXRouteAsReqUriInReg Enable this flag to allow P-CSCF
to use the PSX returned route as the Request URI in the register.
disabled (default)
enabled
usePsxRouteForEmergencyCall Enable this flag to allow SBC
to use PSX returned Route instead of stored-service route
information for processing Emergency calls from Registered users.
disabled (default)
enabled
validateAor If enabled, the AoR must be validated. If disabled,
anonymous users are allowed.
disabled
enabled (default)
variantType Specifies the SIP variant type.
mgcf
q1912
sonus
ttc
uk
state Administrative state of SIP trunk group.
disabled (default)
enabled
ucidSupport Universal Call ID (UCID) support flag.
none (default)
passthruOrGenerate If User-to-User Header with UCID is
received, it is allowed to pass through. If User-to-User Header is
received without UCID, the UCID is generated and attached.

CLI Reference Guide

Zone
Address Context
TABLE 4 27 SIP Trunk Group Early Media Parameters

Parameter
Length/
Range Description
earlyMedia
N/A
Use this object to define early media parameters.
forkingBehaviour
N/A
Use object to select one of following forking behaviors to apply to

the specified SIP trunk group.
firstProvResponse First Reliable Provisional response.
Cut through for first provisional response and suppress the rest
until final response is received.
lastProvResponse (default) Last Reliable Provisional
response. Cut through when the latest provisional response with
SDP is received.
pemPriority PEM (Privacy Enhanced Mail) based. Cut
through occurs based on the value of the PEM header (default
value is sendrecv if not configured).
method
N/A
Use this parameter to select the Early Media method.

pEarlyMedia P-Early-Media header value is used for
selection the RTP streams.
defaultGatingMethod Select an option to specify the
cut-through method if p-early-media header is not received
from peer.
inactive
recvonly
sendonly
sendrecv (default)
egressSupport
disabled
enabled (default)
rtpServerTable Enter an RTP Server Table name to
specify the RTP server profile. This option uses RTP Server
Profile to determine whether early media is enabled. If the c-line
of the session description matches an entry in the RTP profile,
early media is allowed. RTP Server Profiles are configured per
Address Context. One RTP Server Profile is tied to a single
Early Media Profile if this option is selected.
sessionAnswer (default) Media cut-through on receipt of
session answer.
Command Examples
To display the configured Zone and ID assignments:
% show addressContext default zone EXTERNAL
zone EXTERNAL {
id 2;

4 129
CLI Reference Guide

Address Context
Zone
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,siptls-tcp;
}
sipTrunkGroup HUMPI_EXT {
state enabled;
mode
inService;
policy {
carrier
0000;
country
1;
sipDomain
"";
localizationVariant northAmerica;
digitParameterHandling {
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
elementRoutingPriority DEFAULT_IP;
}
media {
4 130

CLI Reference Guide

Zone
Address Context
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;
state
enabled;
policy {
description
"";
sip {
fqdn "";
}
packetServiceProfileId "";
ipSignalingProfileId
"";
}
}
sipSigPort 1 {
LIF1;

4 131
CLI Reference Guide

Address Context
Zone
ipAddress
10.34.9.103;
portNumber
5060;
state
enabled;
transportProtocolsAllowed sip-udp,sip-tcp,siptls-tcp;
}
sipTrunkGroup HUMPI_INT {
state enabled;
mode
inService;
policy {
carrier
0000;
country
1;
sipDomain
"";
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
}
media {
}
services {
}
signaling {
ipSignalingProfile DEFAULT_SIP;
}
}
signaling {
methods {
notify allow;
}
}
media {
4 132

CLI Reference Guide

Zone
Address Context
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;
}
h323TrunkGroup tg {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
sendingCompleteEnbloc disabled;
}
ipPeer ippeer {
ipAddress
1.2.3.4;
ipPort
0;
defaultForIp false;
4 133
CLI Reference Guide

Address Context
Zone
}
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;
}
gwTrunkGroup GW1 {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;
accMc1Percent 90;
accMc2Percent 70;
accTimer
0;
packetOutage {
minimumDuration
6000;
minimumCalls
1000;
bandwidthLimitReduction 50;
4 134

CLI Reference Guide

Zone
Address Context
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;
}
}
media {
mediaIpInterfaceGroupName ipinterface;
sourceAddressFiltering
disabled;
}
}
h323TrunkGroup tg {
state
disabled;
mode
outOfService;
action
dryUp;
dryUpTimeout
5;

4 135
CLI Reference Guide

Address Context
Zone
sendingCompleteEnbloc disabled;
policy {
carrier
0000;
country
1;
numberingPlan
NANP_ACCESS;
ingressDmPmRule "";
egressDmPmRule
"";
}
callRouting {
}
media {
}
services {
}
signaling {
ipSignalingProfile DEFAULT_H323;
}
}
packetOutage {
minimumDuration
6000;
minimumCalls
1000;
bandwidthLimitReduction 50;
detectionState
disabled;
detectionInterval
15;
}
callReservation {
inbound
1;
state
disabled;
priorityCallMinimum 1;
incomingCallMinimum 1;
outgoingCallMinimum 10;
silc {
state
4 136
disabled;
CLI Reference Guide

Zone
Address Context
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;
ldcEmergencyCalls exclude;
}
}
media {
mediaIpInterfaceGroupName ipinterface;
sourceAddressFiltering
disabled;
directMediaAllowed
disabled;
directMediaGroupId
0;
preAllocateResPad
disabled;
}
callRouting {
ansSupervisionTimeout
300;

4 137
CLI Reference Guide

Address Context
Zone
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 {
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 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
4 138

CLI Reference Guide

Zone
Address Context
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/H.323 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/H.323 signaling ports:
% show status addressContext a1 zone INTERNAL
sipSigPortStatus
sipSigPortStatus 1 {
state inService;
}
% 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;

4 139
CLI Reference Guide

Address Context
Zone
Different Signaling Port per AoR Contact

This feature supports configuring multiple SIP signaling ports (up to 16) in the
same zone facing the AS:
As much as possible, select a different egress SIP signaling port for multiple
contacts for the same AoR.
All requests from a registered user are sent out on the egress side through
the same SIP signaling port towards the registrar.
Below are CLI command examples to configure multiple SIP signaling ports:
% 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
The following CLI commands 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 provides the IP address, port number and the transport parameters
from the source IP packet carried in the REGISTER message reaching the
registrar in the SIP proprietary header- X-Original-Addr.
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 an additional header (X-Original-Addr)
in the outgoing SIP Register message as follows:
REGISTER sip:10.3.255.150:5060 SIP/2.0
4 140

CLI Reference Guide

Zone
Address Context
Via: SIP/2.0/UDP
10.3.255.1:5060;branch=z9hG4bK00B000b62fb005af43f
From: <sip:9711000000@10.3.255.150>;tag=gK00000fca
To: <sip:9711000000@10.3.255.150>
Call-ID: 512_3123187670_1823140541@10.3.255.1
CSeq: 1162827419 REGISTER
Max-Forwards: 70
Allow: INVITE, ACK, CANCEL, BYE, REGISTER, REFER, INFO,
SUBSCRIBE, NOTIFY, PRACK, UPDATE, OPTIONS, MESSAGE,
PUBLISH
Contact: <sip:9711000000@10.3.255.1:5060;dtg=TG_INET1;reginfo=200>;q=0.0;expires=3600
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 supports the following:
Overwrites the IP address in the SDP connection information (c=) line with
the source IP address of the received message.
The following CLI commands are used to configure mapping the source IP/port to
the SDP c= line:
% 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"
criterion 2 type messageBody messageBody messageBodyType
all
action 1 type variable

4 141
CLI Reference Guide

Address Context
Zone

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
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:

4 142

CLI Reference Guide

Zone
Address Context

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. Always configure this value to be smaller.
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:

% set profiles media packetServiceProfile DEFAULT flags
useDirectMedia enable
SDP Transparency
SDP transparency support the transparency of ICE parameters as well as other
SDP parameters that are sent transparently through the SBX.
The following set of CLI commands support the use of SDP transparency:
Initially, 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 and 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.

4 143
CLI Reference Guide

Address Context
Zone
Deleting a Zone
You delete a zone using the delete addressContext <addressContext
name> zone <zonename> command. You must delete all objects (SIP/H.323
signaling ports and trunk groups) assigned to a zone before deleting a zone.
4 144

CHAPTER 5
Global
Overview
The global object contains objects that are applicable node wide. Topics include:
"CAC" on page 5 2
"Call Routing" on page 5 7
"Call Trace" on page 5 17
"Carrier" on page 5 24
"Country" on page 5 26
"License" on page 5 29 * add content
"Monitor Endpoint" on page 5 30 * add content
"Monitor Target" on page 5 31 * add content
"NPA/Nxx" on page 5 33
"QoE Call Routing" on page 5 34 * add content
"Script" on page 5 35
"Security" on page 5 37
"Servers" on page 5 38
"Signaling" on page 5 42
"SIP Domain" on page 5 49
"Subscriber" on page 5 50
51
CLI Reference Guide

Global
CAC
CAC
Use this feature to define multi-level Call Admission Control (CAC) policy using IP
hierarchal trunks. A hierarchy is created by linking trunks together in a pyramidtype structure. Regular IP trunks are at the base of the pyramid; above them in the
pyramid are IP linked trunks or shared CAC-limits pools.
A shared CAC-limits pool is a global resource that constrains the resource usage
of a set of trunks. Both the limit and current usage is maintained for each value. A
shared CAC-limits pool is not tied to a specific zone or address context. There
may be up to 2,000 shared CAC limits pools on SBC 5x00.
Validation rules:
There can only be one parent for any object.

An IP trunk group can be assigned as child to any CAC-limits pool (parent).
A CAC-limits pool can be assigned as a parent to any other CAC-limits pool
that does not have a parent of its own.
A CAC-limits pool cannot be assigned to a parent if it already has a CAClimits pool child.
The children of a particular CAC-limits pool can be either CAC-limits pools or
IP trunks.
Call processing rules when using shared CAC-limits pool involve:
Applying the configured limits.

Checking the limits of the parent above in the pyramid. If limits are met by all
parents, the call is admitted.
The hierarchy has a maximum of three levels: two levels of shared CAC-limits
pool and an IP trunk at the bottom. The hierarchy is built bottom up by assigning a
parent to an existing trunk group or CAC-limits pool. The parents must exist
before being assigned.
NOTE
When deleting a parent and associated child CAC, be sure to first deassociate the child from the parent before deleting the parent CAC. Do
not attempt to delete both in the same transaction. See examples
below:
Scenario1:
% delete addressContext AC1 zone ZONE_IAD sipTrunkGroup TG1
% commit
% delete global cac sharedCacLimitsPool CAC0
% commit
52

CLI Reference Guide

CAC
Global
Scenario2:
% delete global cac sharedCacLimitsPool CAC0
% commit
% delete global cac sharedCAcLimitsPool CAC1
% commit
Command Syntax
Use the following CLI syntax to configure global CAC policy:
% set global cac sharedCacLimitsPool <pool_name>
bandwidthLimit <0-2000000000, unlimited>
callLimit <0-2000000000, unlimited>
egress
callBurstMax <1-2000, unlimited>
callRateMax <1-1000, unlimited>
otherReqBurstMax <1-2000, unlimited>
otherReqRateMax <1-2000, unlimited>
registerBurstMax <1-2000, unlimited>
registerRateMax <1-2000, unlimited>
subscriberBurstMax <1-2000, unlimited>
subscriberRateMax <1-2000, unlimited>
ingress
callBurstMax <1-2000, unlimited>
callRateMax <1-1000, unlimited>
otherReqBurstMax <1-2000, unlimited>
otherReqRateMax <1-2000, unlimited>
registerBurstMax <1-2000, unlimited>
registerRateMax <1-2000, unlimited>
subscriberBurstMax <1-2000, unlimited>
subscriberRateMax <1-2000, unlimited>
registrationLimit <0-2000000000, unlimited>
subscriptionLimit <0-2000000000, unlimited>

53
CLI Reference Guide

Global
CAC
Command Parameters
TABLE 5 1
Global CAC Parameter
Parameter
Length/
Range Description
cac
N/A
Use this object to specify shared CAC-limits pool name.
sharedCacLimitsPool
N/A
<pool_name> The name of the shared CAC-limits

pool. Object containing CAC-limits that apply to a set of
trunk groups.
bandwidthLimit Total Media Bandwidth Limit (in
Kbits/sec). (range: 0-2000000000, or unlimited / default
is unlimited)
bandwidthLimitThreshold Bandwidth utilization
notification threshold. (range: 0-100 / default = 0)
callLimit The total number of concurrent calls
(either ingress or egress) allowed. (range: 02000000000, or unlimited / default is unlimited)
callLimitThreshold Call Limit utilization
notification threshold, as a percentage. (range: 0-100 /
default = 0)
egress Egress-specific CAC configuration.
callBurstMax Maximum allowed burst (above
the allowed sustained rate) for egress call attempts.
callRateMax Maximum sustained egress call
rate allowed in calls/second. (range: 1-1000, or
unlimited / default is unlimited)
NOTE: You can set both callRateMax and
callBurstMax as unlimited; however, if you
assign a value to one parameter, the other must
also be assigned a value.
54
otherReqBurstMax Maximum allowed burst

(above the allowed sustained rate) for all other
egress out-of-dialog SIP request. (range: 1-2000, or
unlimited / default is unlimited)
otherReqRateMax Maximum sustained egress
rate of all other out-of-dialog SIP request allowed in
one second. (range: 1-2000, or unlimited / default is
unlimited)
registerBurstMax Maximum allowed burst
(above the allowed sustained rate) for egress initial
SIP registrations. (range: 1-2000, or unlimited /
default is unlimited)

CLI Reference Guide

CAC
TABLE 5 1
Global
Global CAC Parameter (Continued)

Length/
Range Description
Parameter
N/A
sharedCacLimitsPool
(continued)
registerRateMax Maximum sustained egress

rate of initial SIP registrations allowed. (range: 12000, or unlimited / default is unlimited)
registerRateMax as unlimited; however, if you
assign a value to one parameter, the other must
also be assigned a value.
subscribeBurstMax Maximum allowed burst

(above the allowed sustained rate) for egress initial
SIP Subscribe request. (range: 1-2000, or unlimited /
subscribeRateMax Maximum sustained egress
rate of initial SIP SUBSCRIBE request allowed in
subscribes/second. (range: 1-2000, or unlimited /
emergencyOversubscription The percentage
over the configured allowed number of resources for an
IP trunk group that Emergency calls can consume. Up
to 10x can be allocated. (range: 1-1000 / default = 100)
ingress Ingress-specific CAC configuration. (see
egress description above for list of parameters)
parentSharedCacLimitsPoolName Name of an
existing shared CAC-limits pool.
registrationLimit The total number of
concurrent SIP registrations allowed. (range: 02000000000, or unlimited / default is unlimited)
subscriptionLimit The total number of
concurrent SIP subscriptions allowed. (range: 02000000000, or unlimited / default is unlimited)
Command Example
% set global cac sharedCacLimitsPool POOL bandwidthLimit
1000 bandwidthLimitThreshold 1 callLimit 1000
callLimitThreshold 1 egress callBurstMax 50
% show global cac
sharedCacLimitsPool POOL {
callLimit
1000;
callLimitThreshold
1;
bandwidthLimit
1000;
bandwidthLimitThreshold 1;
egress {
55
CLI Reference Guide

Global
CAC
callBurstMax 50;
}
}
56

CLI Reference Guide

Call Routing
Global
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 5 1 Route and Route Label Objects
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

57
CLI Reference Guide

Global
Call Routing
Command Syntax
To configure a route:
% set global callRouting route <entity type:
callingNumber|carrier|none|trunkGroup> <elementID1>
<elementID2> <routingType: standard|username>
<destination national> <destination country> <call type>
<digit type> <time range profile> <call param. filter
profile> <domain name> routingLabel <routing label>
% set global callRouting routingLabel <routingLabel
identifier>
action <routes|scripts>
overflowNOA <type>
overflowNPI
<data|isdn|none|private|spare0Unknown|spare1...spare7|
telex>
overflowNumber <string>
routePrioritizationType
<allProportionAllocation|leastCostRouting|proportionAl
location|roundRobin|sequence>
routingLabelRoute <0-32000>
cost
inService
ipPeer
proportion
testing
trunkGroup
script
<BLOCKING|DEFAULT_TERMINATING|NONSUB_DENY|NO_ROUTES_FO
UND|SCREENING|TANDEM>
% show global callRouting route
callingNumber <callingNumber>
carrier <carrier>
none <none>
trunkGroup <trunkGroup>
% show global callRouting routingLabel <routingLabel>
58

CLI Reference Guide

Call Routing
Global
Command Parameters
TABLE 5 2
Global Call Routing Parameters
Parameter
Length/
Range
Description
entityType
N/A
Specifies the originating entity type:

callingNumber
carrier
trunkGroup
or
none
elementId1
0-31
Specifies the ID1 of the selected entityType. Depending upon the

entityType selection, this field will have different values.
elementId2
0-31
For callingNumber, the value is calling number.

For carrier, the value is carrier.
For none, the value is Sonus_NULL.
For trunkGroup, the value is ingress trunk group.
Specifies the ID2 of the selected entityType. Depending upon the

entityType selection, this field will have different values.
For callingNumber, the value is calling country.

For carrier, the value is Sonus_NULL.
For none, the value is Sonus_NULL.
For 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.
destinationNational
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.
destinationCountry
0-15
For standard routingType, the value is the called country code.

For username routingType, the value is Sonus_NULL.

59
CLI Reference Guide

Global
TABLE 5 2
Call Routing
Global Call Routing Parameters (Continued)
Parameter
Length/
Range
callType
N/A
Description
Call type options:
digitType
N/A
Digit type options:
5 10
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
subscriberType
test
tollFree

CLI Reference Guide

Call Routing
TABLE 5 2
Global
Parameter
Length/
Range
Description
digitType
(continued)
N/A
timeRangeProfile
0-23
Time range 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.
callParameterFilter
Profile
0-23
Call Parameter Filter Profile associated with this route.
domainName
0-63
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
Type of action to be taken by the routing label. Options are:
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.
routes This routing label returns a set of routes.

script This routing label returns a script.
overflowNOA
N/A
Specifies the overflow Nature Of Address (NOA). Options are:
950
aniNotAvailableOrNotProvided
aniOfCalledPartyNationalNumber
aniOfCalledPartyNoNumberPresent
aniOfCalledPartySubscriberNumber
aniOfCallingPartyNationalNumber
aniOfCallingPartySubscriberNumber
any
apnNumberingPlan
ignore
international
internationalNotRestricted
internationalRestricted
national
nationalNotRestricted
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
noNumberOperatorRequested

5 11
CLI Reference Guide

Global
TABLE 5 2
Call Routing
Parameter
Length/
Range
Description
overflowNOA
(continued)
N/A
overflowNPI
N/A
Overflow Numbering Plan Indicator (NPI). Options are:
overflowNumber
5 12
0-31
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
spare3E
spare3F
spare04
spare4A
spare4B
spare4C
spare4D
spare4E
spare4F
spare05
spare5A
spare5B
spare5C
spare5D
spare5E
spare5F
spare06
spare6A
spare6B
spare6C
spare6D
spare6E
spare6F
spare07
spare7A
spare7B
spare7C
spare7D
spare7E
spare7F
spare08
spare09
spare10
spare11
spare12
spare13
spare14
spare15
spare16
spare17
spare18
spare19
spare20
spare21
spare22
spare23
spare24
spare25
spare26
data
isdn
none
private
spare0Unknown
spare1 - spare7
telex
If the overflow number is present, it is used to determine a routing

label and additional routes that will be associated with the call.

CLI Reference Guide

Call Routing
TABLE 5 2
Global
Parameter
routePrioritization
Type
Length/
Range
N/A
Description
Determines how the Embedded Routing Engine (ERE) allocates
the routes contained within this routing label. Options are:
allProportionAllocation The ERE uses proportions
to determine all of the routes in the route list on a call-by-call
basis. For the first route, the ERE follows the process
described above for the Proportion option by generating a
random number. For the second route, the ERE recalculates
the associated random number range for the remaining routes
and then generates a new random number. The ERE
continues this process to populate each of the remaining
routes in the route list.
leastCostRouting The ERE 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 ERE 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 ERE 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 ERE allocates the routes in the order of the
values provided in the route Sequence field.

5 13
CLI Reference Guide

Global
TABLE 5 2
Call Routing
Parameter
Length/
Range
Description
routingLabelRoute
0-32000
Defines the data rows for Routing Label. 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).
(range: 1-1000000 / default is 1000).
inService Flag to indicate if route is available for routing.
inService (default)
outOfService
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.
(range: 0-999 / default = 9.
testing Mode for making test calls and verifying routes
before using them.
nonTest When selected, the ERE does not return the
route when the CPC value in a policy request is Test Call.
When the CPC value is not a Test Call or is not present in
the policy request, the ERE returns the route. Select this
option to identify 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
ERE 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 ERE returns the route. When the CPC value is not Test
Call or is not present in the policy request, the ERE does not
return the route.
trunkGroup Specifies the name of the trunkgroup to use
for this route. Enter a string.
script
N/A
Defines script type. 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
5 14
1-64

commands.

CLI Reference Guide

Call Routing
Global
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 displays when the key in the specified position
is 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;
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;

5 15
CLI Reference Guide

Global
Call Routing
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 {
trunkGroup REHL_1;
ipPeer
REHL_1;
proportion 0;
inService
inService;
testing
normal;
}
}
5 16

CLI Reference Guide

Call Trace
Global
Call Trace
The global Call Trace command allows you to create and configure Call Trace
Filters using criteria to determine call events added to the system trace data event
log (which uses the .TRC file extension). The first three Call Trace filters are
logged unless the stopMatch flag in enabled (whereby the number of filters
logged may be less than three). The stopMatch flag will halt filter profile
matching once a match is found.
The maxTriggerCount parameter is used to set/reset the Trigger Count, a
mechanism used to limit the logging of call/error filter events in the .TRC file.
Please note that a system reboot, an application restart or a Live Software
Upgrade (LSWU) causes the following call trace filters to go offline:
callFilter
callFilter/mediaPacketCapture
callFilter/callDetailCapture
signalingPacketCapture
To rectify this, disable and then re-enable the applicable filters using the following
CLI command syntax:
% set global callTrace signalingPacketCapture state disable
% set global callTrace signalingPacketCapture state enable
% set global callTrace callFilter <filterName> state
disabled
% set global callTrace callFilter <filterName> state enabled
% set global callTrace callFilter <filterName>
mediaPacketCapture disable
mediaPacketCapture enable
callDetailCapture disable
callDetailCapture enable
NOTE
As a general rule, set Call Trace to ingress mode unless egress mode is
specified.
WARNING
Do not turn on the Call Trace Filter to trace all calls. Doing so may
cause poor system performance. Instead, use this mechanism to trace
specific calls.

5 17
CLI Reference Guide

Global
Call Trace
Use the following criteria to establish a Call Trace Filter:
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
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
Policy Request
Policy Response
Policy processing of calls in different layers like pre-processor, services, prerouter, router, and post-router.
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.
5 18

CLI Reference Guide

Call Trace
Global
Use the maxTriggerCount parameter 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 less than 65.
Command Syntax
Use following CLI syntax to configure call trace filters:
// Mandatory parameters required to configure a Call Filter.
% set global callTrace callFilter <callFilter_name>
callDetailCapture <disable|enable>
level <level1|level2|level3>
match
called <string>
calling <string>
cddn <string>
contractor <string>
peerIpAddress <IP address>
redirecting <string>
transferCapability <audio31Khz|speech|unrestricted|
unrestrictedWithTones|video>
trunkGroup <trunkGroup_name>
mediaPacketCapture <disable|enable>
stopMatch <supported|unsupported>
// Non-mandatory parameters for configuring a Call filter.
% set global callTrace callFilter <callFilter_name>
key
<called|calling|cddn|contractor|peerIpAddress|redirect
ing|transferCapability|trunkGroup>
% set global callTrace errorFilter errorType
<any|earlyAttempt|none|outOfDialog|parseError>
% set global callTrace maxTriggerCount <0-64>
% set global callTrace signalingPacketCapture

5 19
CLI Reference Guide

Global
Call Trace
devices <port name> <VLAN tag, or 0 for no tag>

filter <filter_name>
localIpAddress <IP address>
localPortNumber <#>
peerIpAddress <IP address>
peerIpAddressPrefix <0-128>
state <disable|enable>
NOTE
The default value for vlanTag is 0. If you want to configure VLAN and
capture the packets on a specific VLAN, you must provide the devices
name and the vlanTag value.
To configure signaling state:
% set global callTrace signalingPacketCapture state <enable
| disable>
Command Parameters
TABLE 5 3
Global Call Trace Parameters
Parameter
Length/
Range Description
callFilter
1-23
errorFilter
N/A
The name of a call trace filter to apply to the system trace data
log file. This filter may be created, configured, and deleted. See
Table 5 4 for sub-parameter descriptions.
Call error trace for SIP Call Traces only.
errorType 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 is not 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 and not
forwarded to SIP signaling to prevent logging an offending
PDU by both the pre-parser and SIP signaling.
5 20

CLI Reference Guide

Call Trace
TABLE 5 3
Global
Global Call Trace Parameters (Continued)
Parameter
Length/
Range Description
maxTriggerCount
0-64
signalingPacketCapture N/A
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 (default = 0).
Specifies the signaling packet capture devices and the admin
state. These files are saved as .pkt files. The options are:
devices List of devices for signaling packet capture. The
options are:
portName The port name of the device to be used for
the signaling capture (ex. mgmt0).
vlanTag The VLAN tag of the device used for signaling
capture (range: 0-4094 / 0 for no VLAN).
filter Contains the list of signaling filters for the node.
The options are:
<filter name> User name of signaling trace filter.
localIpAddress <IP Address>
localPortNumber <port_number>
peerIpAddress <IP_address>
peerIpAddressPrefix <IP_adress prefix>
state Specifies whether to enable or disable signaling
packet capture feature.
disable (default)
enable
TABLE 5 4
Global Call Trace Call Filter Parameters
Parameter
Length/
Range
Description

Specifies whether the call details are captured or not. These files
will be saved as .out files.
callDetailCapture
disable (default)
enable
level
N/A
The trace level of this call trace entry.

NOTE: Currently, only one level is supported.
level1 Trace everything.
level2 (default) Trace everything but raw hex dumps.
level3 Traces only external message information (ISDN/
ISUP/CAS etc.) and errors.

5 21
CLI Reference Guide

Global
TABLE 5 4
Call Trace
Global Call Trace Call Filter Parameters (Continued)
Parameter
Length/
Range
match
N/A
Description
Use the match keyword to specify criteria to use to capture call
data upon a match. Options are:
called Called number being traced. (range: 0-30).

calling Calling number being traced. (range: 0-30).
cddn Called directory number being traced. (range: 0-30).
contractor Contractor number being traced. (range: 0-30).
NOTE: For the above parameters, use X or x wildcard
character to match any single digit, and % symbol to
match any digits from that point forward.
For example, using 978xxx1212 returns all calls between
9780001212 and 9789991212, and using 978% returns all
calls with a 978 prefix.
peerIpAddress The peer IPv4 or IPv6 address for call

tracing.
redirecting The redirecting number being traced (default
is ).
transferCapability Transfer capability of the call trace
filter. Options are:
audio31Khz 3.1 kHz Audio ITC 3.1 kHz audio calls are
traced.
speech ITC Speech based calls are traced.
unrestricted (default) Calls with ITC Unrestricted are
traced.
unrestrictedWithTones Calls with ITC Unrestricted
Digital Information With Tones Announcements are traced.
video Calls with ITC Video are traced.
trunkGroup Trunk group name to match against.
mediaPacketCapture
N/A
Specifies whether to enable or disable media packet capture

settings. These files will be stored as .pkt files.
disable (default)
enable
state
N/A
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 When enabled, all calls are processed by this filter
for possible inclusion in the system trace data log file.
stopMatch
N/A
Use this flag to stop matching filter profiles once a match is found:
unsupported (default) Continue matching filter profiles even
after a match is found (up to three profiles can be matched).
supported Stop matching filter profiles once a match is
made.
5 22

CLI Reference Guide

Call Trace
TABLE 5 4
Parameter
Global
Global Call Trace Call Filter Parameters (Continued)

Length/
Range
Description

key
N/A
Use this option to specify one or more key components which are
active on the filter (default is ).
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.
Command Examples
To enable call tracing based on the called number:
% set global callTrace callFilter CF-1 level level1 state
enabled key called,calling match called 978%
% set global callTrace callFilter CF-1 mediaPacketCapture
enable
% set global callTrace callFilter CF-1 callDetailCapture
enable
To view the recently-enabled call trace filter:
% show table global callTrace callFilter
callFilter CF-1 {
state
enabled;
level
level1;
key
called,calling;
match {
called 978%;
}
mediaPacketCapture enable;
callDetailCapture
enable;
To enable signaling packet capture:

% Set global callTrace signalingPacketCapture state enable

5 23
CLI Reference Guide

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.
Use the set global carrier command to define a carrier name and assign it
a code and service.
Command Syntax
% set global carrier <carrierID> services classOfService
<COS name>
% show global carrier <carrierID>
services
classOfService <classOfService_name>
Command Parameters
TABLE 5 5
Global Carrier Parameters
Parameter
Length/
Range
carrierID
1-4
Specifies a code to be associated with this carrier. May be up to four

numeric digits.
services
N/A
Services associated with the specified carrier.
Description
classOfService Class Of Service associated with the specified

carrier.
displaylevel
1-64
Command Example
To display the configuration of all carrier parameters:
% show global carrier
carrier 0000 {
services {
classOfService "";
}
5 24

CLI Reference Guide

Carrier
Global
}
carrier 333 {
services {
}
}
carrier 444 {
services {
}
}

5 25
CLI Reference Guide

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 first install the database. You must add
any missing country codes applicable to your network to ensure accurate call
processing.
Command Syntax
% set global country <country code>
listOfNumberOfDigitsToMatch
called <list of digit lengths in called #>
calling <list of digit lengths in calling0 #>
criteria <list of digit lengths in called # for pattern
matching>
% set global country <countrycode> variableLengthDialPlan
<disable|enable>
% show global country <countrycode>
% show global country listOfNumberOfDigitsToMatch
called <called>
calling <calling>
criteria <criteria>
% delete global country <countrycode>
5 26

CLI Reference Guide

Country
Global
Command Parameters
TABLE 5 6
Global Country Parameters
Parameter
Length/
Range
Description
<countrycode>
0-15
Specifies a unique identifier for the country.
listOfNumberOfDigi
tsToMatch
N/A
Select any one of the matching pattern.
variableLengthDial
Plan
N/A
displaylevel
1-64
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.
Specifies the variable length Dial Plan flag.
commands.
Command Example
To display the current list of country codes:
% show global country
1
A unique identifier for the Country Code.
20
27
30
31
- A unique identifier for the Country Code.
32
33
34
36
39
......................
To view the config. details of a specific country code:
admin@Hackos% show global country 1
listOfNumberOfDigitsToMatch {
called
10,6,3,0;

5 27
CLI Reference Guide

Global
Country
calling
10,6,3,0;
criteria "";
}
variableLengthDialPlan disable;
[ok][2012-07-06 06:24:45]
[edit]
admin@Hackos%
NOTE
The show command displays first 100 entries from the country option.
To view the country name that you have created, use wild card.
5 28

CLI Reference Guide

License
Global
License
Use this object to configure the licensed sessions notification threshold value.
Command Syntax
% set global license
sessionsThreshold <0-100>
Command Parameters
TABLE 5 7
Global License Parameters

Length/
Range Description
Parameter
Use this object to configure global license threshold.
license
0-100
sessionsThreshold
Notification threshold percentage. (default = 90)
Command Example
% set global license sessionsThreshold 80
% show global license
sessionsThreshold 80;

5 29
CLI Reference Guide

Global
Monitor Endpoint
Monitor Endpoint
The criteria for recording calls is configured in PSX and when a call meets the
criteria, PSX indicates the need for media forking in the Policy Response to SBC
5x00. This feature allows you to configure the Monitor Endpoint server where the
captured media is sent.
Command Syntax
% set global monitorEndpoint mct <monitor endpoint name>
ipAddress <intfc_ip_address>
portNumber <sip_signaling_port_#>
trunkGroup <TG_name>
Command Parameters
TABLE 5 8
Global Monitor Endpoint Parameters
Parameter
Length/
Range Description
monitorEndpoint
N/A
Use this control to configure the monitor endpoint.

mct <monitor endpoint name>
ipAddress Logical IP address of the interface.
portNumber UDP/TCP port number of SIP signaling
port. (default = 5060).
state Administrative state of MCT. Changes can
only be made when state is disabled, and are applied
upon next enable action.
disabled (default)
enabled
trunkGroup Name of trunkgroup used by MCT.
Command Example
% set global monitorEndpoint mct <MCT-1> ipAddress
<10.22.33.44> portNumber <5060> state enabled> trunkGroup
<SIPTX-EAST>
5 30

CLI Reference Guide

Monitor Target
Global
Monitor Target
Use this feature to configure the target whose media is captured and sent to the
monitoring server.
Command Syntax
% set global monitorTarget <target_name>
duration <1-65535>
gcid <0-2147483647>
monitorEndpoint <endpoint name>
monitorLeg <all|both|egress|ingress>
Command Parameters
TABLE 5 9
Global Monitor Target Parameters
Parameter
Length/Range
monitorTarget
N/A
Description
Use this control to configure monitor target settings.
<target name>
duration The duration (in seconds) that the monitor
target is tapped. (range: 1-65535 / default = 0)
gcid The target GCID (Global Call Identifier) to tap
(range: 0 - 2147483647).
monitorEndpoint Name of endpoint to use for
recording.
monitorLeg Specifies which leg to tap:
all All four legs in GW-GW network.
both (default) Both ingress and ingress leg.
egress
ingress
state Administrative state of the monitor target:
disabled (default)
enabled

5 31
CLI Reference Guide

Global
Monitor Target
Command Example
% set global monitorTarget mciTarget duration 1000 gcid 100
monitorEndpoint MyEndpoint monitorLeg both state enabled>
5 32

CLI Reference Guide

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 <NPA NXX value> portedFlag
<disable|enable>
Command Parameters
TABLE 5 10 Global NPA/Nxx Parameters
Parameter
Length/
Range
Description
npaNxx
N/A
National destination code.
portedFlag
N/A
Enable flag to port national destination code for LNP.

disable (default)
enable
displaylevel
1-64
Command Example
To display the NPA/Nxx configurations:
% show global npaNxx
npaNxx National2 {
portedFlag enable;
}

5 33
CLI Reference Guide

Global
QoE Call Routing
QoE Call Routing
Use this feature to enable/disable the Media QoS and Signaling QoS feature
control flags.
Command Syntax
% set global qoeCallRouting
mediaQosBasedRouting <disabled|enabled>
signalingQosBasedRouting <disabled|enabled>
Command Parameters
TABLE 5 11 Global QoE Call Routing Parameters
Parameter
Length/
Range Description
qoeCallRouting
N/A
Use this control enable/disable mediaQosBasedRouting

and/or signalingQosBasedRouting flags.
mediaQosBasedRouting
N/A
Enable this Media QoS Feature control flag to start Media

QoS KPI calculation and validation.
disabled (default)
enabled
signalingQosBasedRouting
N/A
Enable this Signaling QoS Feature control flag to start

Signaling QoS KPI calculation and validation.
disabled (default)
enabled
Command Example
% set global qoeCallRouting mediaQosBasedRouting enabled
signalingQosBasedRouting disabled
5 34

CLI Reference Guide

Script
Global
Script
The script object is used to view the information about pre-seeded scripts.
Command Syntax
% set global script <script>
majorVersion <0-999>
minorVersion <0-999>
% show global script <script>
majorVersion <0-999>
minorVersion <0-999>
% delete global script <script>

5 35
CLI Reference Guide

Global
Script
Command Parameters
TABLE 5 12 Global Script Parameters
Parameter
Length/
Range
Description
script
N/A
Specifies the script file name without the file extension. Default options:
BLOCKING
DEFAULT_TERMINATING
NONSUB_DENY
NO_ROUTES_FOUND
SCREENING
TANDEM
description
0-199
Specifies a more descriptive information about the script.
majorVersion
0-999
Major script version. (default = 1).
minorVersion
0-999
Minor script version. (default = 0).
displaylevel
1-64
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;
5 36

CLI Reference Guide

Security
Global
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 <0-7>
ikeRetransmitInterval <2-10>
% show global security
ipsec
ikeRetransmitCount
ikeRetransmitInterval
% delete global security ipsec ikeRetransmitCount
ikeRetransmitInterval
Command Parameters
TABLE 5 13 Global Security Parameters
Parameter
Length/
Range Description
ikeRetransmitCount
0-7
ikeRetransmitInterval 2-10
Specifies the Ike Message retransmit count. (default = 5).

Specifies the Ike Message retransmit interval in seconds.
(default = 4).
Command Example
To display the global configuration of all country codes:
% show global security
ipsec {
ikeRetransmitInterval 2;
ikeRetransmitCount
2;

5 37
CLI Reference Guide

Global
Servers
Servers
The global servers object allows you to configure ENUM and E911 servers.
Additionally, the servers object contains global configurations for DNS servers
used for SIP NAPTR, SRV, and A-record lookups.
Command Syntax
To configure a DNS Server, use the command:
% set global servers
dns global
iterationCount <0-32>
monitoringInterval <0-300>
probeInterval <0-300>
retransmissionCount <0-20>
retransmissionTimer <100-10000>
timeouts <0-32>
e911
<e911_service_name>
criteria triggerCriteria <criteria>
defaultTreatment <applyFinalTreatment|routeAsDialed>
flags active <disable|enable>
requestTimeOut <0-2147483647>
routePrecedence <local|lro>
e911VpcDevice <device_name>
deviceData <0-32767>
ipAddress <ip_address>
enumDomain <domain_name>
ipAddress1 <1st ENUM ip_address>
ipAddress2 <2nd ENUM ip_address>
ipAddress3 <3rd EMNUM ip_address>
enumService <name>
defaultTreatment <applyFinalTreatment|routeAsDialed>
5 38

CLI Reference Guide

Servers
Global
enumDefinitions privateDomainNameForEnumLookups
<private_domain_name>
flags active <disable|enable>
requestTimeOut <0-2147483647>
serviceType <cnam|lnp|sipAor>
Command Parameters
TABLE 5 14 Global DNS Servers Parameters
Parameter
Length/
Range
Description
dns global
N/A
Use this object to configure global DNS settings. Parameters:

iterationCount Global Iteration count limit for DNS
iterations of server requests. (range: 0-32 / default = 8).
monitoringInterval Global monitoring interval (in
seconds) for DNS Servers. (range: 0-300 / default = 5).
probeInterval Global probe interval (in seconds) for
blacklisted DNS Servers. (range: 0-300 / default = 5).
retransmissionCount Global retransmission count limit
for DNS iterations of server requests. (range: 0-20 / default = 2).
retransmissionTimer Global retransmission timer value
(in milliseconds) for DNS iterations of server requests. (range:
100-10000 / default = 500)
timeouts Global number of time outs for blacklisting a DNS
Server. (range: 0-32 / default = 0).
e911
N/A
Use this parameter to configure enhanced 911 service.

<e911_service_name>
defaultTreatment Default treatment to apply for requests
that time out.
applyFinalTreatment
routeAsDialed (default)
flags active
disable (default)
enable
requestTimeOut (range: 0-2147483647 / default = 4000)
routePrecedence Routing treatment to apply in the event
that a location for the caller cannot be determined, either Local
or Last Routing Option (LRO).
local
lro (default)

5 39
CLI Reference Guide

Global
Servers
TABLE 5 14 Global DNS Servers Parameters (Continued)

Parameter
Length/
Range
e911VpcDevice
N/A
Description
Use this object to configure the IP address and port number of the
E911 VoIP Positioning Center (VPC) device.
This parameter is used 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.
deviceData <call priority: 0-32767>
ipAddress <ip_address>
enumDomain
N/A
Use this object to configure ENUM IP addresses for the specified

domain.
enumService
N/A
<domain_name> (up to 64 characters)

ipAddress1 <1st ENUM ip_address>
ipAddress2 <2nd ENUM ip_address>
ipAddress3 <3rd EMNUM ip_address>
Use this object to configure ENUM service.

<service_name> (up to 23 characters)
defaultTreatment
applyFinalTreatment
routeAsDialed (default)
enumDefinitions privateDomainNameForEnumLookups
<private_domain_name>
flags active
disable (default)
enable
requestTimeOut Request timeout value, in milliseconds.
(range: 0-2147483647 / default = 2000)
serviceType <cnam|lnp|sipAor>
Command Example
To configure E911 server, execute the following CLI commands:
% set global country 1 listOfNumberOfDigitsToMatch criteria
10,6,3,0
% commit
% set profiles digitParameterHandling
numberTranslationCriteria DEFAULT_E911 none Sonus_NULL
Sonus_NULL 4451211022 1 lookupType e911
% set global servers e911 DEFAULT_E911 flags active enable
5 40

CLI Reference Guide

Servers
Global
% 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
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:

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:

% set global country 1 listOfNumberOfDigitsToMatch
criteria 10,6,3,0
6. To see the ENUM configuration:

% show global servers
% show profiles digitParameterHandling
ENUM1

5 41
CLI Reference Guide

Global
Signaling
Signaling
These sections describe the configuration objects used for signaling. The
following diagram depicts the signaling configuration.
FIGURE 5 2 Signaling Configuration
The following topics are described in this section:
5 42
"Configuring Gateway Signaling Timers" on page 5 43

"Configuring H.323 Signaling Timers" on page 5 44
"Configuring SIP Peer Overload Control" on page 5 45"Configuring SIP
Signaling Controls" on page 5 47

CLI Reference Guide

Signaling
Global
Configuring Gateway Signaling Timers

This object allows you to configure the signaling timers for the gateway.
Command Syntax
% set global signaling gwSigTimers
congRelDelay <delay in seconds>
establish <timer value, in seconds>
idle <idle time, in hours>
keepalive <keepalive time, in seconds>
retry <number of minutes to attempt to recover GW
signaling link>
% show global signaling gwSigTimers
congRelDelay <delay in seconds>
idle <idle time, in hours>
keepalive <keepalive time, in seconds>
retry <number of minutes to attempt to recover GW
signaling link>
% delete global signaling gwSigTimers
Command Parameters
TABLE 5 15 Global Gateway Signaling Timers Parameters
Parameter
Length/
Range
congRelDelay
N/A
Amount of time (in seconds) that a call which is rejected due to congestion
will be delayed before the release is issued. (default = 0).
displaylevel
1-64
establish
N/A
The Gateway Signal Channel Establishment Timer (in seconds.) This

value applies to all signal channels. (default = 10).
idle
N/A
Amount of time (in hours) a GW Signaling Link May be idle before it is

taken down. (default = 0).
keepalive
N/A
The Gateway Signal Channel Keepalive Timer (in seconds.) This value
applies to all signal channels. (default = 3).
Description

5 43
CLI Reference Guide

Global
Signaling
TABLE 5 15 Global Gateway Signaling Timers Parameters (Continued)

Parameter
Length/
Range
retry
N/A
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 = 60).
displaylevel
1-64
Description
Configuring H.323 Signaling Timers

This object allows you to configure signaling timers for the node.
Command Syntax
% set global signaling h323SigTimers
t301 <timer value, in seconds>
t310 <T3timer value, in seconds10>
tcpConnect <tcpConnect>
% show global signaling h323SigTimers
t302 <timer value, in seconds302>
tcpConnect <timer value, in seconds>
% delete global signaling h323SigTimers
5 44

CLI Reference Guide

Signaling
Global
Command Parameters
TABLE 5 16 Global H.323 Signaling Timers Parameters
Parameter
Length/
Range
establish
0-127
The H225 signal channel establishment timer (in seconds). Default value
is 4.
T301
0-65535
The T301 call timer (in seconds). Default value is 180 seconds.
T302
0-127
T303
0-127
T304
0-127
displaylevel
1-64
Displays different levels of output information in show commands.
T310
0-127
tcpConnect
0-127
The TCP connect timer (in seconds). Default value is 3 seconds.
Description
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.
Command Syntax
% set global signaling sipPeerOverloadControl
discardPeriod <1-10 seconds>
rejectThreshold <0-50>
samplingPeriod <1-10>
stepDownGain <1-200>

5 45
CLI Reference Guide

Global
Signaling
% show global signaling sipPeerOverloadControl

discardPeriod <1-10 seconds>
rejectThreshold <0-50>
samplingPeriod <1-10>
stepDownGain <1-200>
% delete global signaling sipPeerOverloadControl
Command Parameters
TABLE 5 17 Global SIP Peer Overload Control Parameters
Parameter
Length/
Range Description
discardPeriod
1-10
Discard period (in seconds) for the Peer Overload back-off

algorithm. (default = 2).
rejectThreshold
0-50
Specifies the reject threshold (in rejects/sec) for the Peer Overload
backoff algorithm. (default = 1).
samplingPeriod
1-10
Specifies the sampling period (in seconds) for the Peer Overload
back-off algorithm. (default = 2).
stepDownGain
1-200
Specifies the step down gain for the Peer Overload back-off
algorithm. (default = 100).
displaylevel
1-64
Command Example
To display the global configuration of all SIP overload control:
% show global signaling sipPeerOverloadControl
samplingPeriod
2;
discardPeriod
1;
stepDownGain
44;
rejectThreshold 33;
5 46

CLI Reference Guide

Signaling
Global
Configuring SIP Signaling Controls

This object allows you to configure SIP signaling parameters.
Command Syntax
% set global signaling sipSigControls
egressRNParam <disabled|enabled>
loopDetectionFeature <disabled|enabled>
maxPduSizeState <pdusize2kb|pdusize3kb|pdusize6kb>
multipleContactsPerAor <disabled|enabled>
registrarSupportContactParam <disabled|enabled>
suppressErrorInfoHdr <disabled|enabled>
ucidNodeId <node_id>
% show global signaling sipSigControls
egressRNParam <disabled|enabled>
loopDetectionFeature <disabled|enabled>
maxPduSizeState <pdusize2kb|pdusize3kb|pdusize6kb>
multipleContactsPerAor <disabled|enabled>
registrarSupportContactParam <disabled|enabled>
suppressErrorInfoHdr <disabled|enabled>
ucidNodeId <node_id>
% delete global signaling sipSigControls
Command Parameters
TABLE 5 18 Global SIP Signaling Control Parameters
Parameter
Length/
Range Description
egressRNParam
N/A
The 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:
disabled
enabled (default)

5 47
CLI Reference Guide

Global
Signaling
TABLE 5 18 Global SIP Signaling Control Parameters (Continued)

Parameter
Length/
Range Description
loopDetectionFeature
N/A
When enabled, the SIP Stack performs loop detection on

incoming INVITE messages.
disabled The SIP signaling group processes the INVITE
message.
enabled (default)
N/A
maxPduSizeValue
The maximum PDU size that recognized by SBC 5x00 software:

pdusize2kb 2048 bytes
pdusize3kb 3072 bytes
pdusize6kb (default) 6000 bytes
multipleContactsPerAor N/A
This flag enables support of multiple contacts per Address Of

Record (AoR).
disabled Only a single contact per Address of Record is
supported.
enabled (default) Multiple contacts per Address of record
are supported.
registrarSupportContac N/A
tParam
suppressErrorInfoHdr
N/A
Enable flag to support parameters in the Contact header:

disabled parameters in the Contact header are not
supported. This value is provided only for backwards
compatibility.
enabled (default) parameters in the Contact header are
supported.
Enable flag to suppress Error-Info header in a response to a
request message with syntax error.
enabled SBC 5x00 does not include Error-Info header in
an error status.
disabled (default) SBC 5x00 includes Error-info header in
the response.
ucidNodeId
1-32767 UCID Node Id used to generate the UCID in the User-to-User

Header. (default = 0)
Command Example
To display the global configuration of all SIP signaling control parameters:
% show global signaling sipSigControls
loopDetectionFeature
enabled;
registrarSupportContactParam enabled;
5 48
suppressErrorInfoHdr
disabled;
maxPduSizeValue
pdusize6kb;
multipleContactsPerAor
enabled;
egressRNParam
disabled;

CLI Reference Guide

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 5 19 Global SIP Domain Parameters
Parameter
Length/
Range
<sipDomainName> 0-23
displaylevel
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 more
information on carrier details, refer to "Carrier" on page 5 24.
1-64
Command Example
To display the global configuration of all SIP domain names:
% show global sipDomain
sipDomain sipDomain1 {
sipDomain sipDomain2;
nonLocal disable;
}

5 49
CLI Reference Guide

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 identifier> <country>
<owning carrier>
services classOfService <CoS identifier>
% show global subscriber <subscriber identifier> <country>
<owning carrier>
services classOfService <CoS identifier>
% delete global subscriber <subscriber identifier>
Command Parameters
TABLE 5 20 Global Subscriber Parameters
Parameter
Length/
Range
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 5 26.
country
0-15
Country in which the subscriber resides.
owningCarrier
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 5 24.
packetServiceProfile 0-23
Specifies that the packet service profile is used to override the IP

trunk groups packet service profile.
classOfService
5 50
0-23
This parameter assigns a Class of Service to the Subscriber.

CLI Reference Guide

Subscriber
Global
TABLE 5 20 Global Subscriber Parameters (Continued)

Parameter
Length/
Range
displaylevel
1-64
Description
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;
}
}

5 51
CLI Reference Guide

Global
5 52
Subscriber

CHAPTER 6
Operations and Maintenance (OAM)
Overview
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 6 2
"Alarms" on page 6 13
"Event Log" on page 6 15
"Local Authentication" on page 6 25
"Radius Authentication" on page 6 27
"SNMP" on page 6 29
"Traps" on page 6 31
61
CLI Reference Guide

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:
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 Set up CDR call configuration. For more information, refer to

"Configuring Admin (Call CDR)" on page 6 2.
cdrServer Transfer files to external CDR server. For more information, refer
to "Configuring External CDR Server" on page 6 6.
radius Transfer files to external radius server. For more information, refer to
"Configuring Radius Server" on page 6 10.
local server disk Records are always written to local disk.
The following sub-sections include CLI details.
Configuring Admin (Call CDR)

To set up CDR call configuration, use the following command syntax.
Command Syntax
% set oam accounting admin
earlyAttemptState <disabled|enabled>
generationMode <allcalls|destination|none|origination>
intermediateAcctInterval <interval, in seconds>
intermediateAcctMode <interval|telcordia>
intermediateAcctState <disabled|enabled>
intermediateLongDurGenTime <hr:min:sec:deci-sec>
intermediateLongDurThreshold <duration, in hours>
intermediateTrapState <disabled|enabled>
maxRecordSequenceNum <uint16|uint32>
62

CLI Reference Guide

Accounting
populateIpTgFarEndSwitchType <disabled|enabled>
populateNonPortedLnpNumbers <false|true>
populateRemoteGsxInfoState <disabled|enabled>
secondStageInheritFirstStage <false|true>
sendEgressCdrInfoOnReceipt <false|true>
startAcctState <disabled|enabled>
% show oam accounting admin
arlyAttemptState <disabled|enabled>
generationMode <allcalls|destination|none|origination>
intermediateAcctInterval <interval>
intermediateAcctMode <interval|telcordia>
intermediateAcctState <disabled|enabled>
intermediateLongDurGenTime <time>
intermediateLongDurThreshold <hrs>
intermediateTrapState <disabled|enabled>
maxRecordSequenceNum <uint16|uint32>
populateIpTgFarEndSwitchType <disabled|enabled>
populateNonPortedLnpNumbers <false|true>
populateRemoteGsxInfoState <disabled|enabled>
secondStageInheritFirstStage <false|true>
sendEgressCdrInfoOnReceipt <false|true>
startAcctState <disabled|enabled>
Command Parameters
TABLE 6 1
Parameter
CDR Admin Parameters

Length/
Range
earlyAttemptState N/A
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:
disabled (default) Do not generate early ATTEMPT records.
enabled Generate early ATTEMPT records.

63
CLI Reference Guide

TABLE 6 1
Accounting
CDR Admin Parameters (Continued)
Parameter
Length/
Range
generationMode
N/A
Description
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 H.323 calls, accounting records are generated for all
calls (ingress and egress), unless this value is none.
intermediateAcctI N/A
nterval
Intermediate Accounting Interval in seconds. (range: 5-86400 /

default = 60).
NOTE: This object only applies when sonusAcctIntAcctMode is
set to interval(1).
intermediateAcctM N/A
ode
The method by which intermediate records are generated.
intermediateAcctS N/A
tate
Use this flag to specify whether INTERMEDIATE Accounting Records

are generated for calls which are stable for a duration exceeding the
intermediate account interval.
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.
enabled
disabled (default)
intermediateLongD N/A
urGenTime
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
----
hour
0..23
minutes
0..59
seconds
0..60 (use 60 for leap-second)
deci-seconds 0..9
intermediateLongD 1-24
urThreshold
The Accounting INTERMEDIATE Records Duration (in hours). 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. (default = 24).
intermediateTrapS N/A
tate
Specifies whether a trap is generated when an INTERMEDIATE

record is generated.
enabled
disabled (default)
64

CLI Reference Guide

Accounting
TABLE 6 1
CDR Admin Parameters (Continued)
Parameter
Length/
Range
maxRecordSequence N/A
Num
Description
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.
populateIpTgFarEn N/A
dSwitchType
Enable flag to use Ingress Far End Switch Type passed down from
ERE IP Trunkgroup for SIP ingress calls.
disabled (default)
enabled
populateNonPorted N/A
LnpNumbers
Enable flag to populate the Called Number Before Translation field in

the accounting record for a number for which an LNP lookup was
performed and lookup indicated that number has not been ported.
false
true (default)
populateRemoteGsx N/A
InfoState
Enable flag to allow destination SBC 5x00 to propagate its billing data
to originating SBC 5x00 for GW-GW calls.
disabled (default)
enabled
secondStageInheri N/A
tFirstStage
Enable flag to allow second stage accounting records for two stage
calls to inherit fields from the first stage call.
false (default)
true
sendEgressCdrInfo N/A
OnReceipt
Enable flag to send the egress CDR information immediately after

receiving and processing it.
false (default)
true
startAcctState
N/A
Specifies whether Start Accounting is enabled or disabled for the

Node.
disabled
enabled (default)
displaylevel
1-64
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
65
CLI Reference Guide

Accounting
secondStageInheritFirstStage true
sendEgressCdrInfoOnReceipt true startAcctState enabled
To display configured CDR administration details:
% show oam accounting admin
generationMode
destination;
intermediateAcctState
enabled;
intermediateAcctInterval
20;
secondStageInheritFirstStage true;
populateNonPortedLnpNumbers
true;
intermediateAcctMode
telcordia;
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]
connectionTimeout <15-600, in seconds>
filePrefix <prefix>
ipAddress <server IP address>
password <encrypted string password data>
path <path>
transferTimeout <15-600, in seconds>
username <name>
% show oam accounting cdrServer admin [primary | secondary]
66

CLI Reference Guide

Accounting
connectionTimeout <15-600, in seconds>

filePrefix <prefix>
ipAddress <server IP address>
password <encrypted string password data>
path <path>
transferTimeout <15-600, in seconds>
username <name>
% delete oam accounting cdrServer admin
% request oam accounting cdrServer admin [primary|secondary]
forceCurrentServer
resetCdrServerStats
Command Parameters
TABLE 6 2
External CDR Server Parameters
Parameter
Length/
Range
Description
admin
N/A
Use this object to specify server type:

primary
secondary
connectionTimeout
15-600
The time to wait, in seconds, before timing out the connect

operation.(default = 30)
filePrefix
N/A
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
The IP Address of the external CDR server. The following IP

example 128.127.50.224).
example, 1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
password
N/A
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 in-line.
path
N/A
The remote directory path where the files should be transferred.
transferTimeout
N/A
The time to wait, in seconds, before timing out the file transfer.
(default = 120).
username
N/A
Remote username.

67
CLI Reference Guide

TABLE 6 2
Accounting
External CDR Server Parameters (Continued)
Parameter
Length/
Range
displaylevel
1-64

commands.
forceCurrentServer
N/A
Use this request parameter to forcibly set the specified server as

the current server.
resetCdrServerStats N/A
Description
Use this request parameter to reset the CDR server statistics.
Command Example
To display the configured CDR server details:
% show oam accounting cdrServer admin
admin primary {
ipAddress
10.10.10.10;
username
admin;
password
$3$6ukQCu3ULEw=;
path
"testPath ";
filePrefix
cdr;
connectionTimeout 15;
transferTimeout
15;
}
To display the complete status of CDR details from system-level command line:
> show table oam accounting cdrServer status
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
------------------------------------------------------------primary
active
secondary standby
idle
idle
To set specified server as current server:

% request oam accounting cdrServer admin secondary
forceCurrentServer
[ok][2010-07-27 04:10:00]
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
------------------------------------------------------------------
68
primary
standby
idle
secondary
active
idle

CLI Reference Guide

Accounting
[ok][2010-07-27 04:12:36]
To reset server statistics for a server:
% request oam accounting cdrServer admin secondary
resetCdrServerStats
[ok][2010-07-27 04:14:33]
>
TYPE
STATE
PROGRESS
SUCCESSFUL
FAILED
PENDING
TRANSFERS
TRANSFERS
TRANSFERS
-----------------------------------------------------------------primary
standby
idle
secondary
active
idle
To configure event log roll interval:

% 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]

69
CLI Reference Guide

Accounting
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.
Command Syntax
% set oam accounting radius
accountingAdmin
failoverPolicy <prioritizedSelection|roundRobin>
maxErrorRate <percentage>
maxNoResponseTime <time, in milliseconds>
maxPacketRetryCount <#>
maxQueuedPacketsInMemory <#>
nasIdentifier <1-253 characters>
nasIpAddress <Ip Address>
sendNasIdentifier <false|true>
sendNasIpAddress <false|true>
radiusServer
cleanupDelay <delay amount>
priority <#>
serverAddress <IPv4 or IPv6 address>
serverPort <UDP port>
sharedSecret <1-128 characters>
6 10

CLI Reference Guide

Accounting
Command Parameters
TABLE 6 3
OAM Accounting Radius Parameters
Parameter
Length/Range
Description
accountingAdmin
N/A
Global accounting configuration for all Radius servers.

Parameters include:
failoverPolicy The failover policy for the radius
servers upon error detection.
prioritizedSelection (default) Select the
server with the highest priority that is not marked as
failed.
roundRobin Select the server with the next lower
priority.
maxErrorRate Maximum percentage of timed out
transactions allowed. If percentage is exceeded, the
RADIUS server is considered failed. (range: 0-100 /
default = 25).
maxNoResponseTime Maximum time allowed, in
milliseconds, to wait for any response from the server. If
no responses are received from a RADIUS server within
the allotted time, the server is considered failed. (range:
1000-10000 / default = 2000)
maxPacketRetryCount Maximum number a packet
is retransmitted before it is dropped, after which it is
assumed that the RADIUS Server rejected the packet.
maxQueuedPacketsInMemory Maximum number of
radius packets allowed to be queued in memory before
they are flushed to disk. Packets are queued up in
memory if no RADIUS servers are available (range:
10000 - 4.294967295E9 / default = 1000000).
nasIdentifier NAS-Identifier to send to RADIUS
server (length: 1-253 characters).
nasIpAddress NAS IPv4 or IPv6 address to send to
the RADIUS server.
sendNasIdentifier If true, send NAS identifier to
the RADIUS server.
false (default)
true
sendNasIpAddress If true, send NAS IP address
to the RADIUS server.
false
true (default)
state Enable flag to send accounting records to
RADIUS server.
disabled (default)
enabled

6 11
CLI Reference Guide

TABLE 6 3
Accounting
OAM Accounting Radius Parameters (Continued)
Parameter
Length/Range
Description
radiusServer
N/A
Use this object to configure individual RADIUS servers.

<server name>
cleanupDelay The time during which the RADIUS
server maintains the received requests after they are
acknowledged so that retries set to the server can be
detected (range: 1-30)
priority The server selection priority for this server.
The lower the numerical value, the higher the priority.
serverAddress The IPv4 or IPv6 IP address of the
server (using hostname, IPv4 address in dot notation, or
IPv6 address in hex-colon notation).
serverPort Target UDP port used to send requests
to the RADIUS server. This can be either a service
name to be looked up in the services file, or an integer
value.
sharedSecret The shared secret used to
authenticate the packet. Length can be between 1 and
128, but be sure to use at least 16 characters.
state The administrative state of the Radius server.
disabled
enabled
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;
6 12

CLI Reference Guide

Alarms
Alarms
The alarms object allows you to configure parameters for the 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 are raised regardless of whether LVM is configured.
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 <inService|outOfService>
majorAlarmProfileName <profile name>
minorAlarmMode <inService|outOfService>
minorAlarmProfileName <profile name>
% show oam alarms ipPolicingAlarmAdmin
majorAlarmMode <majorAlarmMode>
majorAlarmProfileName <majorAlarmProfileName>
minorAlarmMode <minorAlarmMode>
minorAlarmProfileName <minorAlarmProfileName>
% delete oam alarms ipPolicingAlarmAdmin
majorAlarmMode <majorAlarmMode>
minorAlarmMode <minorAlarmMode>
% request alarms clear current alarmId <alarmId>
% request alarms clear current (deletes all alarms in current alarms
table)

6 13
CLI Reference Guide

Alarms
% request alarms clear history (deletes all alarms in the history alarms
table)
% request oam alarms resetIpPolicingAlarmStatus
Command Parameters
TABLE 6 4
IP Policing Alarm Parameters
Parameter
Length/
Range
Description
majorAlarmMode
N/A
Maintenance/service mode for major alarm notification.

inService (default) Active.
outOfService Not active.
majorAlarmProfile N/A
Name
minorAlarmMode
N/A
Policer alarm profile name for major alarm notification.

defaultSystemMajor
defaultSystemMinor
Maintenance/service mode for minor alarm notification.
inService (default) Active.
outOfService Not active.
minorAlarmProfile N/A
Name
displaylevel
1-64
Policer alarm profile name for minor alarm notification.

defaultSystemMajor
defaultSystemMinor
Command Example
This example displays the mode and profile name of major and minor alarms of
the ipPolicingAlarmAdmin object:
% show oam alarms ipPolicingAlarmAdmin
minorAlarmMode
outOfService;
majorAlarmMode
inService;
minorAlarmProfileName defaultSystemMinor;
majorAlarmProfileName defaultSystemMajor;
TABLE 6 5
6 14
Alarm Request Parameters
Parameter
Length/
Range
Description
alarmId
N/A
Specifies that a current-outstanding alarm has to be cleared.

CLI Reference Guide

Event Log
Event Log
This object allows you to create event log filters to capture debug, security,
system, trace, and accounting events using following parameters:
Filter Admin Filter configuration for each event log type and event class.
Filter Status View filterstatus per each event log type and event class (using
the request command).
Subsystem Admin Filter configuration for each subsystem.
Type Admin Event log for configuration items related to each event log type.
Filter Admin
Command Syntax
// Mandatory parameters required to configure an Event log filter admin.
% set oam eventLog filterAdmin <system name>
<event_type: audit|debug|security|system|trace>
<event_class: audit|callproc|directory|netmgmt|policy|
resmgmt|routing|security|signaling|sysmgmt|trace>
// Non-mandatory parameters for Event log filter admin
% set oam eventLog filterAdmin <system_name> <event_type>
<event_class>
level <critical|info|major|minor|noevents>
state <off|on>
Command Parameters
TABLE 6 6
Filter Admin Event Log Parameters
Parameter
Length/
Range
Description
filterAdmin
N/A
Event Log Class Filter configuration table.
<system name>
N/A
SBC 5x00 system name.

6 15
CLI Reference Guide

TABLE 6 6
Event Log
Filter Admin Event Log Parameters (Continued)
Parameter
Length/
Range
<event type>
N/A
Description
The type of event log to configure:
audit System audit data. These files contain a record of all
management interactions that modify the state of the system, and
includes all the changes made via the CLI and the Netconf interface.
These files use .AUD extensions.
debug System debugging data. These files have .DBG extensions.
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.
<event class>
N/A
For each eventType, configure one of the following event:
level
N/A
Minimum severity level threshold for event logging:
state
N/A
audit Audit subsystem.

callproc Call Processing subsystem.
directory Directory Services subsystem.
netmgmt Network Management subsystem.
policy Policy subsystem.
resmgmt Resource Management subsystem.
routing Network Routing subsystem.
security Security subsystem.
signaling Signaling subsystem.
sysmgmt System Management subsystem.
trace Call Trace subsystem.
critical log only critical events.
info log all events.
major log major and critical events only.
minor log all events other than info.
noevents do not log any events.
Administrative state of event logging for this event type. Set to on if filter
entry should take precedence over per-node settings.
off (default) Logging is not activated.
on Logging is activated.
6 16

CLI Reference Guide

Event Log
Filter Status
Command Syntax
% request oam eventLog filterStatus <system_name>
<event_type: audit|debug|security|system|trace>
<event_class: audit|callproc|directory|netmgmt|policy|
resmgmt|routing|security|signaling|sysmgmt|trace>
resetStats
Command Parameters
TABLE 6 7
Filter Status Event Log Parameters
Parameter
Length/
Range
Description
filterStatus
N/A
Event log class filter status table.
<system name>
N/A
SBC 5x00 system name.
<event type>
N/A
The type of event log:

management interactions that modify the state of the system, and
includes all the changes made via the CLI and the Netconf interface.
These files use .AUD extensions.
debug System debugging data. These files have .DBG extensions.
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.
<event class>
N/A
Event class for each event type:
resetStats
N/A
audit Audit subsystem.

callproc Call Processing subsystem.
directory Directory Services subsystem.
netmgmt Network Management subsystem.
policy Policy subsystem.
resmgmt Resource Management subsystem.
routing Network Routing subsystem.
security Security subsystem.
signaling Signaling subsystem.
sysmgmt System Management subsystem.
trace Call Trace subsystem.
Use this control to reset the value of Events Filtered column of the
filterStatus display..

6 17
CLI Reference Guide

Event Log
Subsystem Admin
Command Syntax
// Mandatory parameters required to configure an Event log subsystem event
type.
% set oam eventLog subsystemAdmin <system_name> <subsys_ID>
// Non-mandatory parameters to configure an Event log subsystem event type.
% set oam eventLog subsystemAdmin <system_name> <subsys_ID>
infoLogState <disabled|enabled>
maxEventID <0-4.294967295E9>
minEventID <0-4.294967295E9>
Command Parameters
TABLE 6 8
Subsystem Admin Event Log Parameters
Parameter
Length/
Range
Description
subsystemAdmin
N/A
Subsystem event logging configuration.
<system_name>
N/A
Name of SBC system.
<subsys_ID>
N/A
The subsystem/task ID. For example:
6 18
acm
arma
asg
atmrm
brm
cam
cassg
cc
chm
cli
cmtsg
cnh
cpx
dbug
diamc
dnsc
drm

CLI Reference Guide

Event Log
TABLE 6 8
Subsystem Admin Event Log Parameters (Continued)
Parameter
<subsys_ID>
(continued)
Length/
Range
N/A
Description
ds
ema
enm
fm
frm
grm
gwfe
gwsg
h248fe
h323fe
h323sg
icmsvc
ike
im
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

6 19
CLI Reference Guide

TABLE 6 8
Event Log
Subsystem Admin Event Log Parameters (Continued)
Parameter
<subsys_ID>
(continued)
Length/
Range
N/A
Description
sgisdn
sgisup
sipfe
sipsg
sm
sma
ssa
trm
xrm
Non-mandatory parameters:
infoLogState
N/A
Use this flag to enable/disable event logging of INFO level

messages to DBG and SYS logs for the specified subsystem. By
default, infoLogSate is enabled for all subsystems.
disabled
enabled (default)
NOTE(1): If infoLogState is disabled for CHM, nothing is
written to AUD logs.
NOTE(2): If infoLogState is disabled for CPX, request
commands are not recorded to AUD logs.
maxEventId
N/A
The subsystem's maximum event ID to not filter.
minEventId
N/A
The subsystem's minimum event ID to not filter.
Type Admin
Command Syntax
% set oam eventLog typeAdmin <acct|audit|debug|packet|
security|system|trace>
fileCount <1-1024>
fileSize <256-65535>
fileWriteMode <default|optimize>
filterLevel <critical|info|major|minor|noevents>
messageQueueSize <2-32>
renameOpenFiles <disabled|enabled>
rolloverAction <start|stop>
rolloverInterval <0-2147483647>
rolloverStartTime <time>
rolloverType <repetitive|nonrepetitive>
6 20

CLI Reference Guide

Event Log
saveTo <none|disk>
state <disabled|enabled|rollfile>
syslogRemoteHost <up to 255 characters>
syslogRemotePort <1-65535>
syslogRemoteProtocol <relp|tcp|udp>
syslogState <disabled|enabled>
% request oam eventLog typeAdmin <acct|audit|debug|packet|
security|system|trace>
rolloverLogNow
Command Parameters
TABLE 6 9
Type Admin Event Log Parameters
Parameter
Length/
Range
typeAdmin
N/A
Event Log configuration table for configuration items related to

each Event Log type.
<event_type>
N/A
Specifies the type of event log being configured:
Description
acct System account data. These files have .ACT

extensions.
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 = 32).
fileSize
256-65535
Maximum size (in KB) that a single event log file will ever grow
to. (default = 2048).
fileWriteMode
N/A
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.

6 21
CLI Reference Guide

TABLE 6 9
Event Log
Type Admin Event Log Parameters (Continued)
Parameter
Length/
Range
filterLevel
N/A
Description
Events that are at least as severe as the designated level will be
logged. Options are:
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.
messageQueueSize
2-32
The number of event log message entries to buffer before

writing to disk. (default = 10).
renameOpenFiles
N/A
Enable this flag to rename the most recent accounting file with
.ACT.OPEN extension.
disabled (default)
enabled
rolloverAction
N/A
Event log rollover actions. Options are:

start Start rollover action.
stop Stop rollover action.
rolloverInterval
0Event log rollover interval, in seconds.

2147483647
rolloverStartTime
N/A
Specifies the start time for event log rollover. The format is:
CCYY-MM-DDTHH:MM:SS. For example: 2010-0101T01:01:01
rolloverType
N/A
Event log rollover type. Options are:

nonrepetitive (default) The rollover will occur once at
the specified single instance.
repetitive The rollover will occur repeatedly at the
specified intervals.
saveTo
N/A
Use flag to specify that the events are saved to disk or not
saved.
disk (default)
none
state
N/A
Specifies the requested state of the given Event Log type.

disabled Logging is not activated.
enabled (default) Logging is activated.
rollfile
NOTE: Accounting logs cannot be disabled.
syslogRemoteHost
0-255
The remote host where the messages are written to the syslog.
syslogRemotePort
1-65535
Specifies the port to use to send messages to the remote

syslog. Default value is 514.
6 22

CLI Reference Guide

Event Log
TABLE 6 9
Type Admin Event Log Parameters (Continued)

Length/
Range
Parameter
syslogRemoteProtoc
ol
N/A
Description
The protocol to use to send messages to the remote syslog.
Options are:
relp
tcp (default)
udp
syslogState
N/A
Enable flag to log events of specified type to syslog.

disabled (default)
enabled
rolloverLogNow
N/A
This control is used with request command to perform a rollover of the specified log immediately.
Command Example
This example displays 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;
}
This example configures event log type packet by setting file count to 1,
maximum file size to 256 KB, roll-over interval to 2 seconds, and then enabling the
event log but disabling the logging of events to syslog:
% set oam eventLog typeAdmin packet fileCount 1 fileSize 256
rolloverInterval 2 state enabled syslogState disabled

6 23
CLI Reference Guide

Event Log
% show oam eventLog typeAdmin packet

state
enabled;
fileCount
1;
fileSize
256;
rolloverInterval 2;
syslogState
disabled;
This example sends the command to request an immediate roll-over:

% request oam eventLog typeAdmin packet rolloverLogNow
6 24

CLI Reference Guide

Local Authentication
The local authentication object allows an administrator to manage SBC 5x00 user
authorizations by assigning a user to one of the predefined groups.
For user authentication and group details, please see User Types and Local
authentication topic in Chapter 2 Managing the SBC 5x00 of SBC 5x00
Operations Guide.
Command Syntax
% set oam localAuth
user <user name>
group <Administrator|Calea|FieldService|Guest|Operator>
% show oam localAuth
user <user name>
group <group name>
% delete oam localAuth user <user name>
Command Parameters
TABLE 6 10 Local Authentication Parameters
Parameter
Length/
Range
Description
user
N/A
Specifies the name of the group user.
group
N/A
Use this control to specify user authentication group type:
Administrator
Calea
FieldService
Guest
Operator
NOTE: When a new user is created, the system generates a

password for that account. The new user should change the
default password after initial login.
For more information on changing passwords, refer to "changepassword" on page 2 3.
displaylevel
1-64

6 25
CLI Reference Guide

Command Examples
The following example shows currently configured users and their associated
groups.
% show oam localAuth
user User1 {
group Operator;
}
user User3 {
group Administrator;
}
user User4 {
group Operator;
}
user User8 {
group FieldService;
}
user admin {
group Administrator;
}
6 26

CLI Reference Guide

Radius Authentication
This object provides an option for configuring users on a remote RADIUS server
and authenticating login attempts with that RADIUS server. The authenticating
user should be part of the Administrator group.
Command Syntax
The CLI syntax to configure RADIUS-based authentication is shown below.
% set oam radiusAuthentication
radiusNasIp <NAS IP address>
radiusServerIp <server IP address>
radiusServerPort <server IP port number>
radiusSharedSecret <shared key, 16 to 128 characters>
Command Parameters
TABLE 6 11 Radius Authentication Parameters
Parameter
Length/
Range Description
N/A
Use this object to configure RADIUS-based user

authentication.
radiusNasIp
N/A
NAS IP address. (default is 0.0.0.0)
radiusServerIp
N/A
RADIUS server IP address. (default is 0.0.0.0)
radiusServerPort
1-65535 RADIUS server IP port. (default = 1812)
radiusSharedSecret
16-128
RADIUS server shared key. (default is 123456789abcdef0)

6 27
CLI Reference Guide

Command Example
The following example configures SBC 5x00 to communicate with the external
RADIUS server for user authentication:
% set oam radiusAuthentication radiusNasIp 10.22.33.44
radiusServerIp 10.22.33.45 radiusServerPort 1813
radiusSharedSecret 123456789abcdefg
% show oam radiusAuthentication
radiusServerIp
10.22.33.45;
radiusServerPort
1813;
radiusNasIp
10.22.33.44;
radiusSharedSecret 123456789abcdefg;
The following example enables external RADIUS authentication:
% set system admin TXSBC01a externalAuthenticationEnabled
true
6 28

CLI Reference Guide

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 6 15) but only a small subset of events
generate an SNMP trap message.
Command Syntax
% set oam snmp
trapTarget <trap target name>
port <port number>
% show oam snmp
trapTarget <trap target name>
% show oam snmp trapTarget <trap target name>
port <port number>
% delete oam snmp trapTarget

6 29
CLI Reference Guide

SNMP
Command Parameters
TABLE 6 12 SNMP Parameters
Parameter
Length/
Range
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).
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).
port
N/A
Specifies the port number for SNMP traps. The default port is 161.
state
N/A
Configured state of the trap target entry. Options are:

disabled No traps are sent to the trap server.
enabled Traps are sent to the trap server.
trapType
N/A
Specifies the type of the trap sent to the target. Options are:
inform SNMP notifications will be sent to the trap target server.
v1 Only SNMPv1 traps will be sent to the trap target server.
v2 Only SNMPv2 traps will be sent to the trap target server.
displaylevel
1-64
Command Example
To display the configuration of SNMP parameters:
% show oam snmp
trapTarget trapTarget4 {
port
161;
trapType
V1;
state
enabled;
6 30

CLI Reference Guide

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 reconfiguring the SBC
5x00, and then reenabling them once you are finished. For example, you may
cause a number of traps to get reported as a result of a maintenance activity such
as temporarily detaching cables.Use this object to prevent these traps from
appearing on the SNMP network management stations.
For a list of all possible traps, use the show oam traps command.
Reference the SBC 5x00 Alarms Troubleshooting Guide for trap descriptions.
Command Syntax
% set oam traps
admin <trap name>
dspAdmin
callFailureTrap lackdsp
interval <60-21600 seconds>
threshold <1-65535>
dspAvailabilityTrap
allThreshold <0-100>
g711PacketThreshold <0-100>
g726Threshold <0-100>
g729Threshold <0-100>4
% show oam traps
admin <trap name>
dspAdmin

6 31
CLI Reference Guide

Traps
Command Parameters
TABLE 6 13 OAM Trap Parameters
Parameter
Length/
Range
Description
admin
N/A
Use this object to enable or disable specific traps.

<trap name> The trap name. (see SBC 5x00 Alarms Troubleshooting
Guide for a complete list of traps and their descriptions.)
state When enabled, message are sent to all properly registered
and authenticated management clients.
disabled
enabled (default)
dspAdmin
N/A
DSP resource usage trap configuration. You can configure the following:
callFailureTrap Trap configuration for Call Failure due to no DSP.
Specify the following parameters:
interval The time interval, in seconds, for the threshold of call
failure due to lack of DSP pad.
(range: 60-21600 / default = 300).
threshold Number of call failure due to lack of DSP pad
threshold. (range: 1-65535 / default = 100).
dspAvailabilityTrap DSP Availability trap threshold
configuration. Specify the following parameters:
allThreshold Percentage DSP Availability threshold for all
types. (range: 0-100).
g711PacketThreshold Percentage of G.711 Packet type DSP
Availability threshold. (range: 0-100).
g726Threshold Percentage of G.726 type DSP Availability
threshold. (range: 0-100).
g729Threshold Percentage of G.729 type DSP Availability
threshold. (range: 0-100).
displaylevel
1-64
Command Example
To display the trap information:
% show oam traps admin
sonusConnexIpSystemCEFanFailureNotification
sonusConnexIpSystemCEFanFailureNotification{
enabled
}
6 32

CHAPTER 7
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.
The following profiles are supported:
"Call Parameter Filter Profile" on page 7 2

"Call Routing" on page 7 4
"Digit Parameter Handling" on page 7 14
"Digit Profile" on page 7 35
"DTMF Trigger" on page 7 42
"Feature Control Profile" on page 7 44
"IP Signaling Peer Group" on page 7 45
"Media" on page 7 47
"Security" on page 7 80
"Services" on page 7 89
"Signaling" on page 7 105
"SIP CAC Profile" on page 7 256
"System Profile" on page 7 265
NOTE
When using the show command to view particular profile attributes,

be sure to include the profile name in the command to avoid syntax
errors.
Example to view egressIpAttributes:
% show profiles signaling ipSignalingProfile DEFAULT_SIP
egressIpAttributes
71
CLI Reference Guide

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
<profile name>
% show profiles
callParameterFilterProfile <profile name>
% delete callParameterFilterProfile <profile name>
Command Parameters
TABLE 7 1
Parameter
Call Parameter Filter Profile parameters

Length/
Range Description
callParameterFilter N/A
Profile
Use this object to define the name and description of the Call
parameter filter profile.
<profile name> Default profiles are listed below:
SIP_MSG_TYPE_INFO SIP Message Type is Info.
SIP_MSG_TYPE_MESSAGE SIP Message Type is Message.
SIP_MSG_TYPE_NOTIFY SIP Message Type is Notify.
SIP_MSG_TYPE_REGISTER SIP Message Type is Register.
SIP_MSG_TYPE_SUBSCRIBE SIP Message Type is
Subscribe.
none Seed data for provisioning support.
description Description of the call parameter filter profile
(length: 1-199 characters).
72

CLI Reference Guide

Profiles
Command Example
% set profiles callParameterFilterProfile MY_PROFILE
description My_Profile
% show profiles callParameterFilterProfile
callParameterFilterProfile MY_PROFILE {
description "My_Profile";
}
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 "seed data for provisioning support ";
}

73
CLI Reference Guide

Profiles
Call Routing
Call Routing
SBC 5x00 supports the following type of Call Routing profiles:
"Crankback Profile" on page 7 4

"Element Routing Priority Profile" on page 7 6
"Holiday" on page 7 8
"Time Range Profile" on page 7 9
Crankback Profile
This object creates a Crankback Profile containing a table of call release codes
used by SBC 5x00 to attempt to reroute (or "crankback") a call when a matching
code is returned by Egress Signaling. Release codes may be added or removed
from this table. Removing a release code from the table causes the SBC 5x00
software to return that release code to Ingress Signaling rather than attempt to
reroute the call.
You can configure up to 20 Crankback Profiles (including default profile). As
profiles are created, they are assigned indexes 2, 3, 4, and so on by the SBC
5x00 (index 1 is reserved for default profile). Index assignments are viewable
using the show command.
Use the crankback index number to assign a particular Crankback Profile to a
particular SIP, or H.323 trunk group for ingress signaling.
This object influences rerouting policy for SIP 3xx Redirection processing if the IP
Profile is configured to use the Crankback Profile. For example, 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 examined 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 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.
74

CLI Reference Guide

Call Routing
Profiles
Command Syntax
% set profiles callRouting crankbackProfile <profile_name>
attemptRecordGeneration <disabled|enabled>
lateCrankback <disabled|enabled>
reason <reason code, 1-255>
location <location type>
useLocationValue <disabled|enabled>
Command Parameters
TABLE 7 2
Crankback Profile Parameters
Parameter
Length
/Range Description
crankbackProfile
1-23
attemptRecordGeneration N/A
The name of the Crankback Profile.

Enable this flag to log ATTEMPT record in accounting file after
each crankback.
disabled (default)
enabled
lateCrankback
N/A
Enable flag to allow crankback after an ALERTING,

PROCEEDING, or equivalent backwards call message is
received from egress network.
disabled (default)
enabled
reason
1-255
Call termination reason code value, plus associated location.

<reason_code>
location
internationalNet
natReserved6
natReserved12
netBeyondInterPoint
privateLocal
privateRemote
publicLocal
publicRemote
transitNet
user
useLocationValue Enable flag to use Location table
values for this reason code while cranking back on the next
route.
disabled (default)
enabled

75
CLI Reference Guide

Profiles
Call Routing
Command Example
% set profiles callRouting crankbackProfile CB_CUSTOM
attemptRecordGeneration enabled lateCrankback enabled
reason 10 location publicLocal
% set profiles callRouting crankbackProfile CB_CUSTOM reason
11 location internationalNet
% show profiles callRouting crankbackProfile CB_CUSTOM
lateCrankback
enabled;
attemptRecordGeneration enabled;
reason 10 {
location publicLocal;
}
reason 11 {
location internationalNet;
}
Element Routing Priority Profile

Element Routing Priority profile entries are similar to routing criteria in that they
also select elements that must be factored into a 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
<unique_identifier>
entry <linear_call_type>
<priority#, 0-999>
entityType <callingNumber|carrier|none|trunkGroup>
76

CLI Reference Guide

Call Routing
Profiles
Command Parameters
TABLE 7 3
Element Routing Priority Parameters
Parameter
Length
/Range Description
elementRoutingPriority 1-23
N/A
entry
Element Routing Priority unique identifier.

Select linear call type:
_private
carrierCutThrough
internationalType
ipVpnService
localOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
test
transit
userName
<entityPriority>
0-999
Enter an entity priority.
entityType
N/A
The entity type. The possible values are:
callingNumber
carrier
none (default)
trunkGroup
Command Example
% set profiles callRouting elementRoutingPriority Custom_ERP
entry longDistanceOperator 999
% show profiles callRouting elementRoutingPriority
Custom_ERP
entry longDistanceOperator 999;

77
CLI Reference Guide

Profiles
Call Routing
Holiday
Use this object to provision days of the year which are designated as national
holidays. This feature allows you to apply number translations or specific
treatment on holidays.
Command Syntax
% set profiles callRouting holiday <#> <month> <dayOfMonth>
Command Parameters
TABLE 7 4
Holiday parameters
Parameter
Length/
Range Description
holiday
N/A
Select a holiday number from list.

1
41
55
82
216
230
242
254
267
354
376
423
591
674
686
880
972
6721
78
2
7
43 44
56 57
84 86
218 220
231 232
243 244
255 256
268 269
355 356
377 378
500 501
592 593
675 676
687 688
886 960
973 974
6723
27
45
58
90
221
233
245
257
290
357
379
502
594
677
689
961
975
30
46
60
91
222
234
246
258
291
358
380
503
595
678
690
962
976
31
47
61
92
223
235
247
260
297
359
381
504
596
679
691
963
977
32
48
62
93
224
236
248
261
298
370
385
505
597
680
692
964
992
33
49
63
94
225
237
249
262
299
371
386
506
598
681
850
965
993
34
51
64
95
226
238
250
263
350
372
387
507
599
682
852
966
994
36
52
65
98
227
239
251
264
351
373
389
508
670
683
853
967
995
39
53
66
212
228
240
252
265
352
374
420
509
672
684
855
968
996
40
54
81
213
229
241
253
266
353
375
421
590
673
685
856
971
998

CLI Reference Guide

Call Routing
TABLE 7 4
Profiles
Holiday parameters
Parameter
Length/
Range Description
<month>
N/A
Select a month when prompted.
january
february
march
april
may
june
july
august
september
october
november
december
<day_of_month>
1-31
Enter the day of the month when prompted.
description
N/A
Enter a description for the holiday (default is ).
Command Example
% set profiles callRouting holiday 20 december 25
description Christmas
% show profiles callRouting holiday
holiday 20 december 25 {
description Christmas;
Time Range Profile

Use this object 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 parameters for Time Range Profile
% set profiles callRouting timeRangeProfile <profile_name>
entry <#>
// Non-mandatory parameters for Time Range Profile
entry <#>

79
CLI Reference Guide

Profiles
Call Routing
dayMatching
dayOfWeek <select one or more days>
holidays <disable|enable>
specialDays range <all|days|none>
entry <#>
timeMatching range
all
minutes <hex list>
none
entry <#>
timeZone <select timezone>
Command Parameters
TABLE 7 5
Time Range Profile Parameters
Parameter
Length/
Range
Description
timeRangeProfile
N/A
The Time Range profile name.
entry
N/A
The number of data rows to assign to this Time Range profile.

(range: 0-4294967295)
dayMatching
N/A
Use this object to identify the day to match against, enable/

disable holidays and specify special day range (if applicable).
dayOfWeek Enter one or more days of the week to match
against.
friday
monday
saturday
sunday
thursday
tuesday
wednesday
holidays Enable or disable holidays.
disable (default)
enable
specialDays Specify special day range.
range
all
days days <list in hex format>
none (default)
7 10

CLI Reference Guide

Call Routing
TABLE 7 5
Profiles
Time Range Profile Parameters (Continued)
Parameter
Length/
Range
Description
timeMatching
N/A
Time of day to which the associated entity applies.

range
all (default)
minutes minute <list in hex format>
none
timeZone
N/A
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

7 11
CLI Reference Guide

Profiles
TABLE 7 5
Time Range Profile Parameters (Continued)
Parameter
timeZone
(continued)
7 12
Call Routing
Length/
Range
N/A
Description
greatBritain
greenwich
hongKong
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

CLI Reference Guide

Call Routing
Profiles
Command Example
The following example creates a Time Range Profile named CUSTOMPROFILE as entry #13 for U.S. Central timezone to match against days Monday
through Friday. The time-match parameter is left at default of none.
set profiles callRouting timeRangeProfile CUSTOM-PROFILE
entry 13 timeZone unitedStatesCentral dayMatching
dayOfWeek monday,tuesday,wednesday,thursday,friday
% set profiles callRouting timeRangeProfile CUSTOM-PROFILE
entry 13 timeMatching range none
% show profiles callRouting timeRangeProfile CUSTOM-PROFILE
entry 13 {
timeZone unitedStatesCentral;
dayMatching {
dayOfWeek monday,tuesday,wednesday,thursday,friday;
}
timeMatching {
range none;
}
}

7 13
CLI Reference Guide

Profiles
Digit Parameter Handling
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_id>
dmPmRule <dmPmRule_id>
numberTranslationCriteria <numberTranslationCriteria>
numberingPlan <numberingPlan>
prefixProfile <prefixProfile>
DM/PM Criteria:
% set profiles digitParameterHandling dmPmCriteria
<dmPmCriteria_id>
criteriaType <digit|parameter|uri>
parameterPresenceCheck <doesntExist|exists>
uriCriteria
host
value <0-64 chars>
presentationMatch
value <allowed|none|numberUnavailable|
restricted|spare>
userInfo
7 14

CLI Reference Guide

Profiles
value
matchValue <0-64 chars>
startCharacterPosition <0-63 chars>
validateUserInfoDigits <equals|ignore|notEquals>
uriType <calledUri|callingUri|fromUri|paiSipUri|toUri>
DM/PM Rule:
% set profiles digitParameterHandling dmPmRule <dmPmRule_id>
subRule <0-9>
criteria <dmPmCriteria_id>
ruleType
digit digitManipulation
action
<addDestinationCountry|addIngressTrunkGrou
pCountry|addOriginatingCountry|none>
numberOfDigits
replacement
startDigitPosition
numberType
parameter
uri
uriType
digitManipulation
action <addDestinationCountry|
addIngressTrunkGroupCountry|addOriginatingCou
ntry|none>
numberOfDigits <0-30>
replacement
digitString <252|253|254|billingNumber|
calledDirectoryNumber|calledInNumber|calledNu
mber|calledUri|callingName|callingNumber|
callingUri|causeOfNoId|contractorNumber|
dialedNumber|fromUri|gnAdditionalCalled|
gnAdditionalCalling|gnAdditionalConnected|
gnAdditionalOriginalCalled|gnAdditionalRed
irecting|gnAdditionalRedirection|gnCalledC
esId|gnCollectCallNumber|gnDestination|
gnDialedDigits|gnLocalAni|gnNetworkProvide
7 15
CLI Reference Guide

Profiles
dNumber|gnPortedDialed|gnRedirectingTermin
ating|gnThirdPartyNumber|gnUserCallingNotS
creened|gnUserCallingScreened|location|
none|originalCalledNumber|outpulseNumber|
paiSipDisplayName|paiSipUri|
paiTelDisplayName|presentationNumber|
pretranslated|redirecting|redirection|
sipFromDisplayName|toUri|twoStageCollected
>
numberOfDigits <0-30>
startDigitPosition <0-29>
type <constant|variable>
value <0-64 chars>
startDigitPosition <0-29>
includeInEgress <discardInEgress|
includeInEgress|none>
natureOfAddress <noa_name>
numberLength <0-30, noInput>
numberingPlanIndicator
<data|ignore|isdn|none|offsetUnused|private|s
pare0Unknown|spare1|spare2|spare3|spare4|spar
e5|spare6|spare7|telephony|telex>
presentation <allowed|none|numberUnavailable|
restricted|spare>
screening <networkProvidedNotScreened|
none|userProvidedFailedNetworkScreening|userP
rovidedNotScreened|userProvidedPassedNetworkS
creening>
numberType <billingNumber|calledDirectoryNumber|
calledNumber|callingNumber|contractorNumber|
gnAdditionalCalled|gnAdditionalCalling|gnAdditio
nalConnected|gnAdditionalOriginalCalled|
gnAdditionalRedirecting|
gnAdditionalRedirection|
gnCalledCesId|gnDestination|
gnDialedDigits|gnNQI=252||gnNQI=253|
gnNQI=254|gnNetworkProvidedNumber|
gnPortedDialed|gnRedirectingTerminating|
gnUserCallingNotScreened|gnUserCallingScreened|
location|originalCalledNumber|outpulseNumber|
pretranslated|redirecting|redirection|
twoStageCollected>
ruleType <digit|parameter|uri>
Number Translation Criteria:
numberTranslationCriteria <trigger_criteria_id>
callingNumber
7 16

CLI Reference Guide

Profiles
carrier
none
trunkGroup
Each of the above four parameters use following options:
<element_id_1>
<element_id_1>
<national_code>
<country_code>
lookupType <e911|enumCnam|enumLnp|enumSipAor>
Numbering Plan:
% set profiles digitParameterHandling numberingPlan
<numberPlan_id>
lengths
areaCode
exchangeCode
line
nationalNumber
subscriberNumber
Each of the above parameters uses following sub-parameters:
max <0-999>
min <0-999>
prefixProfile <profile_name>
Prefix Profile:
% set profiles digitParameterHandling prefixProfile
<prefixProfile>
entry <matching pattern: + +86 00 01 1 02
04 4 05 5 06 6 07 7 08 8 09 9 110
115 116 119 120 176>
2 03 3
113 114
Command Parameters
The following parameters are defined in this section:
"DM/PM Criteria Parameters" on page 7 18

"DM/PM Rule Parameters" on page 7 22
"Number Translation Criteria Parameters" on page 7 29
"Numbering Plan Parameters" on page 7 30
"Prefix Profile Parameters" on page 7 31

7 17
CLI Reference Guide

Profiles
DM/PM Criteria Parameters

TABLE 7 6
DM/PM Criteria Parameters
Parameter
Length/
Range Description
dmPmCriteria
N/A
Specifies the name of a DM/PM criteria, which can be assigned to

one or more DM/PM rules.
<unique DM/PM Criteria name> Select an existing rule
or enter a new name.
criteriaType Select the type of manipulation to occur:
digit (default)
parameter
uri
digitCriteria The criteria for applying DM/PM rules.
digitMatch
operation
- equals Criterion applies if the designated value
matches the actual value exactly (see value parameter
below for additional options to choose).
- ignore (default) Do not apply criterion (see value
parameter below for additional options to choose).
- notEquals Criterion applies if the designated value
does not match the actual value (see value parameter
below for additional options to choose).
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
(default = ).
- numberOfDigits 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 ERE would use the first, second, and third digits
of the complete number for the comparison. (range: 02147483647 / default = 0).
7 18

CLI Reference Guide

TABLE 7 6
Profiles
DM/PM Criteria Parameters (Continued)
Parameter
dmPmCriteria
(continued)
Length/
Range Description
1-23
- startDigitPosition The first position within the

complete number specified in Digit Type field to start the
comparison with value specified in the Match Value field.
The start digit position 0 is the left-most digit of the
complete number. (range: 0-2147483647 / default = 0).
egressFlag Egress flag criteria:
operation
- equals Set the egress flag to a particular value.
- ignore (default) Do not apply the criterion in this
section.
- notEquals The criterion applies if the designated
value does not match the actual value.
value Choose whether to apply DM rule for egress flag:
- dontSend
- send
natureOfAddress NOA criteria
operation (same as for egressFlag above)
value:
950 (default)
any
apnNumberingPlan
ignore
international
national
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
none
passThrough
spare00...spare26

7 19
CLI Reference Guide

Profiles
TABLE 7 6
Parameter
dmPmCriteria
(continued)
Length/
Range Description
1-23
7 20
numberLength
operation: Specify how to match the Number Length
criteria with the specified value (in value field):
- equals
- greaterThanOrEquals
- ignore (default)
- lessThanOrEquals
- notEquals
value <unsignedInt> (range: 0-32 / default = 0)
numberingPlanIndicator
operation: Specify how to match the Numbering Plan
Indicator with the specified value (in value field):
- equals
- ignore (default)
- notEquals
value:
data (default)
isdn
private
spare0Unknown
spare1
spare2
spare3 - spare7
telex
presentationMatch
operation: Specify how to match the Presentation Match
- equals
- ignore (default)
- notEquals
value
allowed
none (default)
numberUnavailable
restricted
spare

CLI Reference Guide

TABLE 7 6
Profiles
Parameter
dmPmCriteria
(continued)
Length/
Range Description
1-23
screeningMatch
operation: Specify how to match the Screening Match
- equals
- ignore (default)
- notEquals
value:
networkProvidedNotScreened
none (default)
userProvidedFailedNetworkScreening
userProvidedNotScreened
userProvidedPassedNetworkScreening
digitType Digit/parameter type to apply this DM/PM Criteria.
<252 | 253 | 254 | billingNumber (default)
calledDirectoryNumber | calledInNumber
calledNumber | callingNumber
contractorNumber | dialedNumber | fromUri
gnAdditionalCalled | gnAdditionalCalling |
gnAdditionalConnected |
gnAdditionalOriginalCalled |
gnAdditionalRedirecting |
gnAdditionalRedirection | gnCalledCesId |
gnCollectCallNumber | gnDestination
gnDialedDigits | gnLocalAni
gnNetworkProvidedNumber | gnPortedDialed |
gnRedirectingTerminating |
gnThirdPartyNumber |
gnUserCallingNotScreened
gnUserCallingScreened | location |
originalCalledNumber | outpulseNumber |
presentationNumber | pretranslated |
redirecting | redirection |
twoStageCollected>
parameterPresenceCheck Check for presence of this call
parameter when applying DM/PM rule.
doesntExist The ERE applies the associated PM rule if
the parameter is not present in call parameters.
exists (default) The ERE applies the associated PM rule if
the parameter is present in call parameters.

7 21
CLI Reference Guide

Profiles
DM/PM Rule Parameters

TABLE 7 7
DM/PM Rule Parameters
Parameter
Length/
Range Description
dmPmRule
1-23
The name of this DM/PM (digit manipulation/parameter

manipulation) rule.
NOTE: The DM/PM rules below are default rules. You can
also create your own DM/PM rules.
Following are default DM/PM rules:
subRule
N/A
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
Sub-rule priority (0-9)

criteria DM/PM Criteria:
CALLED_NOA_NATIONAL | CALLING_!SEND |
CALLING_ALLOWED | CALLING_EXISTS |
CALLING_NOA_NATIONAL | CALLING_NOT_EXISTS |
CALLING_RESTRICTED | CLG_NAME_EXISTS |
GN_CALLING_ALLOWED | GN_CALLING_EXISTS |
GN_CALLING_NOA_NATIONAL |
GN_CALLING_NOT_EXISTS | GN_CALLING_RESTRICTED
| GN_DIALED_NOA_NATIONAL | OCN_NOA_NATIONAL |
PAI_TEL_DISPLAY_NAME | SIP_MATCH_INTL_CD |
SIP_MATCH_INTL_CG | SIP_MATCH_INTL_GNACG |
SIP_MATCH_INTL_GNOCLD | SIP_MATCH_INTL_ORIGIN |
SIP_MATCH_INTL_PORTED | SIP_MATCH_INTL_RDRCTG |
SIP_MATCH_INTL_RDRCTN | SIP_MATCH_NOINTL_CD |
SIP_MATCH_NOINTL_CG | SIP_MATCH_NOINTL_GNACG |
SIP_MATCH_NOINTL_GNOCLD |
SIP_MATCH_NOINTL_ORIGIN |
SIP_MATCH_NOINTL_PORTED |
SIP_MATCH_NOINTL_RDRCTG |
7 22

CLI Reference Guide

TABLE 7 7
Profiles
DM/PM Rule Parameters (Continued)
Parameter
Length/
Range Description
subRule (continued)
SIP_MATCH_NOINTL_RDRCTN | SIP_MATCH_PLUS1_GNACG |
SIP_MATCH_PLUS1_GNOCLD | SIP_MATCH_PLUS1_ORIGIN |
SIP_MATCH_PLUS1_PORTED | SIP_MATCH_PLUS1_RDRCTG |
SIP_MATCH_PLUS1_RDRCTN | SIP_MATCH_PLUS39_GNACG |
SIP_MATCH_PLUS39_GNOCLD |
SIP_MATCH_PLUS39_ORIGIN |
SIP_MATCH_PLUS39_PORTED |
SIP_MATCH_PLUS39_RDRCTG |
SIP_MATCH_PLUS39_RDRCTN | SIP_MATCH_PLUS44_GNACG
| SIP_MATCH_PLUS44_GNOCLD |
SIP_MATCH_PLUS52_RDRCTN | SIP_MATCH_PLUS81_CLG |
SIP_MATCH_PLUS81_GNACG | SIP_MATCH_PLUS81_GNOCLD
| SIP_MATCH_PLUS81_ORIGIN |
SIP_MATCH_PLUS91_RDRCTN | SIP_MATCH_PLUS_CLG |
SIP_MATCH_PLUS_GNACG | SIP_MATCH_PLUS_GNOCLD |
SIP_MATCH_PLUS_ORIGIN | SIP_MATCH_PLUS_PORTED |
SIP_MATCH_PLUS_RDRCTG | SIP_MATCH_PLUS_RDRCTN |
TO_HEADER_EXISTS
parameterManipulation Use parameter to specify

parameter manipulation rules.
availability
no
none (default)
yes

7 23
CLI Reference Guide

Profiles
TABLE 7 7
Parameter
Length/
Range Description
subRule (continued)
N/A
characterManipulation
numberOfCharacters Number Of Characters.
replacement Use this parameter to specify
replacement type and value.
- replacementType
- constant (default)
- variable
- value (range: 1-23 characters)
parameterType Parameter Type.
additionalCategory | callingName |
carrierCode | carrierSelectionParameter |
causeOfNoId | chargeRateInfoIndicator |
cliBlockingIndicator | cpc | dpcIndicator
forwardCallIndicator | jurisdiction | olip |
originatingCarrier | originatingChargeArea
paiSipDisplayName | paiTelDisplayName |
sipFromDisplayName | transitNetworkSelection
| zzCode
presentation
<allowed | none | numberUnavailable |
restricted | spare>
ruleType Rule type. (see table for listing of subparameters)

digit
parameter (default)
uri
digitManipulation
N/A
The type of digit manipulation to perform.

digitStringManipulation Options include:
action The action to take when the matching criteria is
met (used for international gateway support involving
setting NOA to International and adding country code):
addDestinationCountry
addIngressTrunkGroupCountry
addOriginatingCountry
none (default)
numberOfDigits Number of digits
replacement Use when this is a replacement DM rule.
startDigitPosition The start digit position
7 24

CLI Reference Guide

TABLE 7 7
Profiles
Parameter
digitManipulation
(continued)
Length/
Range Description
N/A
numberParameterManipulation Options for

manipulating number parameter:
includeInEgress Specify whether to include in
egress, discard in egress or take no action:
discardInEgress
includeInEgress
none (default)
natureOfAddress Nature Of Address options.
950 (default)
any
apnNumberingPlan
ignore
international
national
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
none
passThrough
spare00...spare26
numberLength Enter either noInput or a number.
noInput (default)
<#> (range: 0-31)
numberingPlanIndicator Numbering Plan Indicator
types:
data | ignore | isdn | none |
offsetUnused | private | spare0Unknown |
spare1 | spare2 | spare3 | spare4 |
spare5 | spare6 | spare7 | telephony |
telex

7 25
CLI Reference Guide

Profiles
TABLE 7 7
Parameter
digitManipulation
(continued)
7 26
Length/
Range Description
N/A
presentation Presentation options include:

allowed
none (default)
numberUnavailabl
restricted
spare
screening Network screening indicator of calling party
number. Options include:
networkProvidedNotScreened Networkprovided screening, not screened.
none (default)
userProvidedFailedNetworkScreening Userprovided screening, failed network screening.
userProvidedNotScreened User-provided
screening, not screened.
userProvidedPassedNetworkScreening Userprovided screening, passed network screening.
numberType Specify the number type:
billingNumber (default)
calledDirectoryNumber
calledNumber
callingNumber
contractorNumber
gnAdditionalCalled
gnAdditionalCalling
gnAdditionalConnected
gnAdditionalOriginalCalled
gnAdditionalRedirecting
gnAdditionalRedirection
gnCalledCesId
gnDestination
gnDialedDigits
gnNQI=252
gnNQI=253
gnNQI=254
gnNetworkProvidedNumber
gnPortedDialed
gnRedirectingTerminating
gnUserCallingScreened

CLI Reference Guide

TABLE 7 7
Profiles

Length/
Range Description
Parameter
digitManipulation
(continued)
N/A
TABLE 7 8
location
originalCalledNumber
outpulseNumber
pretranslated
redirecting
redirection
twoStageCollected
Sub-rule Rule Type Parameters
Parameter
Length/
Range Description
digit
N/A
Digit rule type.

criteria (see subRule description in previous table
for list of criteria)
digitManipulation
action <addDestinationCountry|
addIngressTrunkGroupCountry|addOrigi
natingCountry|none>
numberOfDigits (range: 0-30 / default = 0)
replacement
- digitString <digit string>
- numberOfDigits (range: 0-30 / default = 0)
- startDigitPosition <range: 0-29 / default
= 0>
- type <constant|variable>
- value (max. 64 characters)
- includeInEgress <discardInEgress|
includeInEgress|none>
- natureOfAddress <NOA>
- numberLength (0-30, or noInput)
- numberingPlanIndicator <NPA>
- presentation <allowed|none|
numberUnavailable|restricted|spare>
- screening
<networkProvidedNotScreened|none|use
rProvidedFailedNetworkScreening|user
ProvidedNotScreened|userProvidedPass
edNetworkScreening>
numberType <type>

7 27
CLI Reference Guide

Profiles
TABLE 7 8
Sub-rule Rule Type Parameters (Continued)
Parameter
Length/
Range Description
parameter
N/A
Parameter rule type (default).

parameterManipulation
additionalCategory
informationMobile1
<any|[auto]|inflight|maritime|pager>
userName <[mobile1]|mobile2|pstn1>
parameterType <type>
uri
N/A
URI rule type.

numberOfCharacters (range: 0-64 / default =
0)
portNumber (range: 0-65535, or noChange)
replacement
characterString <calledUri|
callingUri|fromUri|none|paiSipUri|to
Uri>
numberOfCharacters
type
value
uriType
7 28

CLI Reference Guide

Profiles
Number Translation Criteria Parameters

TABLE 7 9
Number Translation Criteria Parameters
Parameter
Length
/Range Description
numberTranslationCriteria N/A
The number translation criteria (route) label.

Use this object to configure Number Translation Criteria for
one of following element types: calling number, carrier,
trunk group or none as defined below.
callingNumber
N/A
When configuring number translation for Calling Number,

set the following parameters:
<elementID1> A textual field (1-23 characters) for
informational purposes. For example, the name of the
trunk group which will apply this DM/PM rule.
<elementID2> A textual field (1-23 characters) for
informational purposes. For example, the IP peer of the
trunk group applying this DM/PM rule.
<national> A textual field (1-23 characters) to store
the calling number, called number or number prefix.
<country> Enter the Country code.
lookupType Choose an ENUM lookup type:
e911 (NA variant only)
enumCnam ENUM CNAM
enumLnp ENUM LNP
enumSipAor ENUM SIP Address of Record
carrier
N/A
When configuring number translation for a Carrier, set the

following parameters (see above field descriptions):
N/A
none
When configuring number translation with no element type,

set the following parameters (see above field descriptions):
trunkGroup
N/A
<elementID1>
<elementID2>
<national>
<country>
lookupType
<elementID1>
<elementID2>
<national>
<country>
lookupType
When configuring number translation for a trunk group, set

the following parameters (see above field descriptions):
<elementID1>
<elementID2>
<national>
<country>
lookupType

7 29
CLI Reference Guide

Profiles
Numbering Plan Parameters

TABLE 7 10 Numbering Plan Parameters
Parameter
Length/
Range Description
numberingPlan
N/A
Specifies numbering plan.

NOTE: The numbering plans below are default plans, but you
can also create your own numbering plans.
lengths
N/A
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
The minimum and maximum lengths for various number types.
areaCode
exchangeCode
line
nationalNumber
subscriberNumber
Maximum and minimum values for above parameters:

max <#> Enter maximum value. (range: 0-999 / default = 4).
min <#> Enter minimum value. (range: 0-999 / default = 4).
prefixProfile
7 30
N/A
Prefix profile name.

CLI Reference Guide

Profiles
Prefix Profile Parameters

TABLE 7 11 Prefix Profile Parameters
Parameter
Length/
Range Description
prefixProfile
N/A
Prefix profile name. Enter a profile name or select from list of

default profiles.
NOTE: The prefix profiles below are default profiles. You
may also create your own prefix profiles.
entry
N/A
CHINA_DIAL_PLAN
GENERIC_DIAL_PLAN
GERMANY_DIAL_PLAN
ITALY_DIAL_PLAN
INDIA_DIAL_PLAN
JAPAN_DIAL_PLAN
MEXICO_DIAL_PLAN
NA_DIAL_PLAN
UK_DIAL_PLAN
Use this object to configure the Prefix Profile using the

parameters below.
<matching pattern> (up to 28 characters)

<match start location> 0
<total min digits> 3
<total max digits> 3
applyDmRule Enable to apply Dm/Pm Rule.
disable (default)
enable
callType Select linear Call Type.
_private (default)
carrierCutThrough
internationalType
ipVpnService
localOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
test
transit
userName

7 31
CLI Reference Guide

Profiles
TABLE 7 11 Prefix Profile Parameters (Continued)

Parameter
entry (continued)
Length/
Range Description
determineArea When this flag is enabled, the area code
is determined from the analyzed digits.
disable (default)
enable
digitType Select digit type (default = unknown)
900PremiumToll | 950CarrierAccess |
carrierAccess | directoryAssistance |
easilyIdentifiableNumber | emergency |
governmentEmergency | ieps | international |
internationalOperator |
internetOffloadAnonymous |
internetOffloadEconomy |
internetOffloadPremium |
internetOffloadStandard | internetReception
| ipVpn | localOperator |
longDistanceOperator | national |
nationalOperator | noDigits |
otherCarrierChosen | private |
serviceAccessCode | subscriber |
subscriberOperator | test | tollFree |
transit | unknown | userName |
verticalServiceCode
dmPmRule Dm/Pm Rule identifier:
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_PLUS91
7 32

CLI Reference Guide

Profiles
TABLE 7 11 Prefix Profile Parameters (Continued)

Parameter
Length/
Range Description
entry (continued)
N/A
natureOfAddress Nature Of Address.

950 (default)
any
apnNumberingPlan
ignore
international
national
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
none
passThrough
spare00...spare26
numberLeadingPrefixDigits <#> Enter number of
Leading Prefix Digits (range: 0-999 / default = 0).
numberLeadingPrefixDigitsToStrip <#> Enter
number of Leading Prefix Digits To Strip (range: 0-999 /
default = 0).
numberingPlanIndicator Numbering Plan Indicator.
data | ignore | isdn | none | offsetUnused |
private | spare0Unknown | spare1 | spare2 |
spare3 | spare4 | spare5 | spare6 | spare7 |
telephony | telex
Command Example
% show profiles digitParameterHandling
dmPmCriteria dmpm1 {
parameterPresenceCheck doesntExist;
}
dmPmRule rule1;
numberTranslationCriteria NTC none 2 2 3 4 {
7 33
CLI Reference Guide

Profiles
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;
}
}
}
7 34

CLI Reference Guide

Digit Profile
Profiles
Digit Profile
This object allows you to configure a Digit Profile defining digit generation and
digit detection.
Command Syntax
% set profiles digitProfile <profile name> type dtmf
dtmfDetect
frequenceRange <medium|narrow|wide|wider>
minOffDuration <#>
minOnDuration <#>
minPower <#>
twistCutoff <ratio>
% set profiles digitProfile <profile name> type dtmf
dtmfGenerate
break <duration>
make <duration>
power <power level>
% set profiles digitProfile <profile name> type mfr1
mfr1Detect
frequenceRange <#>
minOffDuration <duration>
minOnDuration <duration>
minPower <power level>
mfr1Generate
break <duration>
make <duration>
makeKp <duration>
power <power level>
mfr2Detect

7 35
CLI Reference Guide

Profiles
Digit Profile
frequenceRange <#>
maxPulseDuration <duration>
minOffDuration <duration>
minOnDuration <duration>
minPower <power level>
postPulseDelay <#>
mfr2Generate
break <duration>
finalDigitDelay <#>
make <duration>
maxFwdOffDuration <duration>
maxFwdOnDuration <duration>
power <power level>
prePulseDelay <#>
7 36

CLI Reference Guide

Digit Profile
Profiles
Command Parameters
TABLE 7 12 Digit Profile Parameters
Parameter
Length/
Range
Description
digitProfile
1-23
The user name of this digit profile with following attribute:

type Specifies the digits format with parameters defined below.
dtmf
N/A
Dual-tone multifrequency (DTMF) digit type. Options include:

dtmfDetect DTMF digit detection attributes:
frequenceRange - Frequency tolerances for digit detection.
medium (default)
narrow
wide
wider
minOffDuration The minimum inter-digit duration (in
milliseconds) for digit detection. The value must be in increments of
5 ms. (range: 25 to 80 / default = 25).
minOnDuration The minimum tone duration (in milliseconds)
required for digit detection. The value must be in increments of 5
ms. (range: 25 to 80 / default = 25.
minPower The minimum power level (in dBm) required for digit
detection. (range: -45 to -25 / default = -45).
twistCutoff Ratio of high to low group power. Twist ratios
above or below the twist cutoff will result in digit detection. (range:
4dB-12dB, in increments of 2dB / default = 8dB).
dtmfGenerate DTMF digit generation attributes. Options include:
break Silence duration (in milliseconds) between generated digits
(range: 0-8000 / default = 100).
make Duration (in milliseconds) of generated digits
(range: 0-8000 / default = 100).
power Digit generation power level in dBm
(range: -50 to +3 / default = 10).

7 37
CLI Reference Guide

Profiles
Digit Profile
TABLE 7 12 Digit Profile Parameters (Continued)

Parameter
Length/
Range
mfr1
N/A
Description
Multilink Frame Relay (MFR) variant 1 digit type.
mfr1Detect MFR1 digit detection attributes.
frequenceRange Frequency tolerances for digit detection.
medium
narrow (default)
wide
minOffDuration Minimum inter-digit duration (in milliseconds)
for digit detection. The value must be in increments of 5ms.
(range: 10-100 / default = 15).
minOnDuration Minimum tone duration (in milliseconds)
required for digit detection. The value must be in increments of 5ms.
(range: 25-100 / default = 25).
minPower Minimum power level (in dBm) required for digit
mfr1Generate MFR1 digit generation attributes. Options include:
make Duration (in milliseconds) of generated digits.
makeKp Duration (in milliseconds) of generated KP digits. (range:
0-8000 / default = 105).
power Digit generation power level (in dBm).
(range: -50 to +3 / default = -7).
mfr2
N/A
Multilink Frame Relay (MFR) variant 2 digit type.

mfr2Detect MFR2 digit detection attributes.
frequenceRange Frequency tolerances for digit detection.
medium
narrow (default)
wide
maxPulseDuration Maximum allowed duration (in milliseconds)
of a received pulsed MF tone. (range: 0-8000 / default = 1000).
minOffDuration Minimum inter-digit duration (in milliseconds)
for digit detection. The value must be in increments of 5ms.
(range: 10-100 / default = 15).
minOnDuration Minimum tone duration (in milliseconds)
required for digit detection. The value must be in increments of 5ms.
(range: 25-100 / default = 25).
minPower Minimum power level (in dBm) required for digit
postPulseDelay Duration (in milliseconds) after a pulse signal
is transmitted when no forward signals are recognized.
(range: 0-8000 / default = 250).
7 38

CLI Reference Guide

Digit Profile
Profiles
TABLE 7 12 Digit Profile Parameters (Continued)

Parameter
mfr2
(continued)
Length/
Range
N/A
Description
mfr2Generate MFR2 digit generation attributes. Options include:
(range: 0-8000 / default = 150)
finalDigitDelay Minimum interval (in milliseconds) after
sending last message to apply answer line signal in the backward
direction. (range: 0-8000 / default = 50).
make Duration (in milliseconds) of generated digits.
(range: 0-8000 / default = 150).
maxFwdOffDuration Maximum amount of time (in milliseconds)
between the removal of a forward signal and the sending of the next
forward signal. (range: 100-60000 / default = 27000).
maxFwdOnDuration Maximum amount of time (in milliseconds)
a forward signal is sent. (range: 100-60000 / default = 15000).
power Digit generation power level (in dBm).
(range: -50 to +3 / default = -7).
prePulseDelay Delay (in milliseconds) between the end of last
compelled signal and the start of backward pulsed signal.
(range: 0-8000 / default = 100).
DTMF Frequency Tolerances

The table below depicts the DTMF Accept and Reject ranges. Frequencies
detected within the Accept range result in digit detection.
DTMF
DTMF
Value
Enumeration
Accept
Reject
---------- ---------------------- -------------- -----------1
narrow
+/-2.0%
+/-3.0%
medium
+/-2.5%
+/-3.5%
wide
+/-3.0%
+/-4.0%
wider
+/-3.5%
+/-4.5%>
MFR1 Frequency Tolerances

The table below depicts only the MFR1 Accept range. Frequencies detected
within this range result in digit detection.
.
MFR1
Value Enumeration Accept
-------- ------------------ -----------------1
narrow
+/-(1.5% + 5Hz)
medium
+/-(1.5% + 10Hz)
wide
+/-(1.5% + 15Hz)

7 39
CLI Reference Guide

Profiles
Digit Profile
MFR2 Frequency Tolerances

The table below depicts only the MFR1 Accept range. Frequencies detected
within this range result in digit detection.
.
MFR2
Value Enumeration Accept
-------- ------------------ -----------------1
narrow
+/-(1.5% + 10Hz)
medium
+/-(1.5% + 20Hz)
wide
+/-(1.5% + 30Hz)
Command Example
% 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 {
7 40
minPower
-30;
minOnDuration
25;
CLI Reference Guide

Digit Profile
Profiles
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;

7 41
CLI Reference Guide

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 <0-65535>
longdigitDuration <0-65535>
pattern <trigger pattern>
Command Parameters
TABLE 7 13 DTMF Trigger Parameters
Parameter
Length/
Range
dtmfTrigger
N/A
Specifies the profile defining conditions for triggering on DTMF digit

strings. The DTMF trigger is allowed for the profiles: ingress and
egress.
interdigitTimeout
0-65535
Specifies interdigit timer in milliseconds. If 0, then timer is disabled.

Enter value in range of 0-65535 in milliseconds. (default = 4000)
longdigitDuration
0-65535
Specifies minimum duration in milliseconds for a digit to be

considered long.
Description
If 0, then long digits are disabled. Enter value in range of 0-65535

in milliseconds. (default = 2000).
pattern
N/A
Specifies the trigger pattern.
state
N/A
Administrative state of this dtmf trigger.

disabled (default)
enabled
displaylevel
7 42
1-64

CLI Reference Guide

DTMF Trigger
Profiles
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;
}

7 43
CLI Reference Guide

Profiles
Feature Control Profile
Feature Control Profile
Use this object to specify whether to allow processing of destination trunk group
and destination trunk context associated with a Feature Control Profile.
Command Syntax
% set profiles featureControlProfile <profile_name>
processDestinationTgrp <disable|enable>
processDestinationTrunkContext <disable|enable>
Command Parameters
TABLE 7 14 Feature Control Profile Parameters
Parameterrunk
Length/
Range Description
featureControlProfile
1-23
The Feature Control Profile name.
N/A
Enable flag to process destination trunk group parameters

associated with the specified Feature Control Profile. The
ERE/PSX performs a light policy lookup and skips all
SSG-based services, number translation and routing
functions.
disable (default)
enable
processDestinationTrunkCon N/A
text
Enable flag to allow processing of destination trunk

context associated with the specified Feature Control
Profile.
disable (default)
enable
Command Example
% show profiles featureControlProfile DEFAULT_IP
disable;
processDestinationTrunkContext disable;
7 44

CLI Reference Guide

IP Signaling Peer Group
Profiles
Command Syntax
% set profiles ipSignalingPeerGroup <peer_group_name>
description <string>
ipSignalingPeerGroupData <0-32000>
sendAllIpAddressAndFQDN <disable|enable>
Command Parameters
TABLE 7 15 IP Signaling Peer Group Parameters
Parameter
Length/
Range Description
1-23
Name of IP Signaling Peer Group profile.
description
1-199
IP Signaling Peer Group description.
ipSignalingPeerGroupData
0-32000 IP Signaling Peer Group configuration details.

<sequence#> Sequence number of this Peer Group
data. (range: 0-32000)
fqdn FQDN to use for sending egress calls/
requests to the IP peer. (up to 63 characters)
fqdnPort Port number for FQDN. (range: 065535 / default = 0)
ipAddress IP address of the IP peer. (default is
0.0.0.0)
ipPort TCP/UDP port for the IP peer. (range: 065535 / default = 0)
serviceStatus Select inService to use this IP
peer.
inService
sendAllIpAddressAndFQDN
N/A
By default, PSX sends one IP address to SBC 5x00 in

round robin order. Enable this flag to send all IP
addresses and FQDNs for the IP Signaling Peer Group in
a single policy response.
disable (default)
enable

7 45
CLI Reference Guide

Profiles
Command Example
% set profiles ipSignalingPeerGroup SIPPeer-1 description
"Peer group example" ipSignalingPeerGroupData 1 fqdn
www.mysite.com fqdnPort 5066 ipAddress 10.22.33.44
serviceStatus inService
% set profiles ipSignalingPeerGroup SIPPeer-1
sendAllIpAddressAndFQDN enable
% show profiles ipSignalingPeerGroup
sendAllIpAddressAndFQDN enable;
ipSignalingPeerGroup SIPPeer-1 {
description "Peer group example";
ipSignalingPeerGroupData 1 {
serviceStatus inService;
ipAddress
10.22.33.44;
fqdn
www.mysite.com;
fqdnPort
5066;
}
}
7 46

CLI Reference Guide

Media
Profiles
Media
The SBC 5x00 uses Packet Service Profile and the Codec Entry to control the
media characteristics for calls. The following Media elements are included in this
section:
"Announcement Package" on page 7 47

"Codec Entry" on page 7 48
"Media QoS KPI Profile" on page 7 60
"Packet Service Profile" on page 7 61
"Tone and Announcement Profile" on page 7 71
"Tone Package" on page 7 73
"Tone Profile" on page 7 76
Announcement Package
SBC 5x00 supports playing announcements and tones, and can collect digits.
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 announcement package for a node:
% set profiles media announcementPackage <pkg name>
element <name>
segmentId <#>
packageID <100-2048>
To display the recently created announcement packages:
% show profiles media announcementPackage <pkg name>
To delete the recently created announcement packages:
% delete profiles media announcementPackage <pkg name>

7 47
CLI Reference Guide

Profiles
Media
TABLE 7 16 Announcement Package parameters

Parameter
Length/
Range
Description
announcementPackage
NA
The Announcement Package name.
element
NA
Specifies a table which contains elements that binds

announcement names to segment ID values for a given
announcement package.
<name> The announcment name for this element.
segmentId The Segment ID for the announcement
segment file that this announcement name is mapped to for
the specified announcement package. (default = 0)
packageID
100-2048
Announcement package identifier defined by the softswitch for

this package.
NOTE: packageID from 0-99 is reserved for seed data.
Codec Entry
Audio codecs are associated with a Packet Service Profile. Some codecs are
used 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).
All audio codecs used by video calls are also used only in pass-through or direct
media mode. Audio codec relay is supported in SIP-SIP, H.323-H.323 as well as
SIP-H.323 interworking calls. For a list of SBC 5x00 supported audio codecs, refer
to 550-05335 SBC 5x00 Operations Guide.
Command Syntax
% set profiles media codecEntry <codec_name>
codec <codec_type>
codingRate <codingRate>
dtmf
relay <relay_type>
removeDigits <disable|enable>
fax
failureHandling <continue|disconnect>
toneTreatment <treatment_type>
law <ALaw|ULaw|deriveFromOtherLeg>
modem
7 48

CLI Reference Guide

Media
Profiles
packetSize <packetSize>
preferredRtpPayloadType <0-128>
sendSid <disable|enable>
% set profiles media codecEntry <codec_name>
codec <codec_type>
dtmf <dtmf>
fax
modem
preferredRtpPayloadType <preferredRtpPayloadType>
% set profiles media codecEntry <codec_name> codec
<amrBandwidthEfficient|amrCrc|amrCrcInterleaving|amrCrcRobus
tSorting|amrInterleaving|amrInterleavingRobustSorting|amrIuU
p|amrOctetAligned|amrRobustSorting|efr>
activeCodecSet <activeCodecSet>
dtmf
relay <relay_type>
fax
fecRedundancy <0|1|2>
modeChangeNeighbor <disable|enable>
modem
packetSize <20|40|60>
silenceSuppression
mode <disable|enable>
vadType <vad1|vad2>

7 49
CLI Reference Guide

Profiles
Media

<amrwbBandwidthEfficient|amrwbBandwidthEfficient|amrwbCrc|am
rwbCrcInterleaving|amrwbCrcInterleavingRobustSorting|amrwbCr
cRobustSorting|amrwbInterleaving|amrwbInterleavingRobustSort
ing|amrwbOctetAligned>
dtmf
relay <relay_type>
fax
modeChangeNeighbor <disable|enable>
modeSet <0-6.6|1-8.85|2-12.65|3-14.25|4-15.85|5-18.25|619.85|7-23.05|8-23.85>
modem
silenceSuppression
vadType <vad1|vad2>
% set profiles media codecEntry <codec_name> codec <efr>
dtmf
relay <relay_type>
fax
modem
silenceSuppression
vadType <vad1|vad2>
7 50

CLI Reference Guide

Media
Profiles

<bv16|bv32|bv32Fec>
dtmf
relay <relay_type>
fax
modem
<evrc|evrc0|evrc1|evrc1Fr|evrcb|evrcb0|evrcb1|evrcb1Fr>
dtmf
relay <relay_type>
fax
modem
silenceSuppression mode <disable|enable>
<g711|g711s|g722|g726|g728|g728ss|g729a|g729ab|g7221|g7221ss
|g7231|g7231a|g7291|ilbc|ilbcss|isac|l1616|msrta8|msrta16|silk8|silk12|silk16|silk24|speex8|speex8Fe
c|speex16|speex16Fec|speex32>
dtmf
relay <relay_type>
fax
7 51
CLI Reference Guide

Profiles
Media
modem
% set profiles media codecEntry <codec_name> codec <g711s>
dtmf <dtmf>
fax
modem
sendSid <disable|enable>
% set profiles media codecEntry <codec_name> codec <g728ss>
dtmf <dtmf>
fax
modem
<g726|g726ss>
codingRate 32
dtmf
relay <relay_type>
fax
7 52

CLI Reference Guide

Media
Profiles
modem
Command Parameters
TABLE 7 17 Codec Entry Parameters
Parameter
Length/
Range
codecEntry
N/A
Description
Specifies the name of an entity consisting of a codec type along
with the set of parameters to use with it. You can define any name
or use the codec names available by default:
codec
N/A
G711-DEFAULT
G711SS-DEFAULT
G723-DEFAULT
G723A-DEFAULT
G726-DEFAULT
G729A-DEFAULT
G729AB-DEFAULT
Select the codec. Following are the supported codecs:
amrBandwidthEfficient
amrCrc
amrCrcInterleaving
amrCrcRobustSorting
amrInterleaving
amrInterleavingRobustSorting
amrIuUp
amrOctetAligned
amrRobustSorting
amrwbBandwidthEfficient
amrwbCrc
amrwbCrcInterleaving
amrwbCrcInterleavingRobustSorting
amrwbCrcRobustSorting
amrwbInterleaving
amrwbInterleavingRobustSorting
amrwbOctetAligned

7 53
CLI Reference Guide

Profiles
Media
TABLE 7 17 Codec Entry Parameters (Continued)

Parameter
Length/
Range
codec (continued)
N/A
7 54
Description
bv16
bv32
bv32Fec
efr
evrc
evrc0
evrc1
evrc1Fr
evrcb
evrcb0
evrcb1
evrcb1Fr
g711
g711ss
g722
g7221
g7221ss
g7231
g7231a
g726
g726ss
g728
g728ss
g7291
g729a
g729ab
ilbc
ilbcss
isac
l16-16
msrta16
msrta8
silk12
silk16
silk24
silk8
speex16
speex16Fec
speex32
speex8
speex8Fec

CLI Reference Guide

Media
Profiles

Parameter
Length/
Range
activeCodecSet
N/A
Description
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:
modeSet
N/A
The modeSet codec set is applicable only for AMRWB codecs.

The possible values are:
dtmf
N/A
0-4.75kbps
1-5.15kbps
2-5.90kbps
3-6.70kbps
4-7.40kbps
5-7.950kbps
6-10.20kbps
7-12.20kbps
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
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-toH.323, or SBC 5x00-to-SBC 5x00. Encodes DTMF into RTP
using format and payload type distinct from audio encoding.

7 55
CLI Reference Guide

Profiles
Media

Parameter
Length/
Range
dtmf (continued)
N/A
removeDigits Enables the removal of DTMF digits from

the media stream. This applies only if DTMF relay is configured
as outOfBand or rfc2833.
disable
enable (default)
fax
N/A
The treatment taken when the fax tone is detected.
Description
failureHandling The behavior when a fax tone is

detected but treatment fails for any reason:
continue (default) Continue to process the call.
disconnect Release the call.
toneTreatment 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 allocation of a
compression resource.
fecRedundancy
N/A
Sets the level for Forward-Error-Correction (FEC) Redundancy

[AMR only].
The options are 0, 1 and 2. The default value of 0 means
FEC redundancy is disabled.
N/A
law
The law derivation of the egress call, which can be:

ALaw
ULaw
deriveFromOtherLeg (default)
modeChangeNeighbor
Enable flag on peer or route PSP to cause SBC 5x00 to configure

DSPs to force mode change to neighboring modes in active
codec set as per RFC4867 (applies to AMR and AMRWB).
disable (default)
enable
7 56

CLI Reference Guide

Media
Profiles

Parameter
Length/
Range
modem
N/A
Description
Specifies the treatment taken when the modem tone is detected,
which can be:
failureHandling 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 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.
NOTE: applyFaxTreatment is not supported for Gateway
Links.
packetSize
N/A
The packet size in milliseconds (ms). Options are:
preferredRtpPayload 0-128
Type
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.
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
1-64

commands.

7 57
CLI Reference Guide

Profiles
Media
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;
}
}
Transcoding Configuration Command Example

Perform the following commands to set up configuration for a transcoded call
between G.711 ulaw and G.729.
% 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
% set profiles media codecEntry codec_out codec g729a
7 58

CLI Reference Guide

Media
Profiles
% 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 and egress profile on Egress IP
peer:
% 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
(Global Call Identifier) for calls are listed.
% show table global callSummaryStatus
Provide GCID for the following command; output shows media type (pass-through
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>

7 59
CLI Reference Guide

Profiles
Media
Media QoS KPI Profile

QoS-based routing towards terminating gateway/subscriber is configurable from
both a signaling and media perspective. For Signaling QoS KPI Profile, see
"Signaling QoS KPI Profile" on page 7 232.
The Media Quality of Service (QoS) Key Performance Indicator (KPI) Profile
allows the user to set the R-Factor threshold KPI to filter out IP trunk group routes
exceeding this threshold.
Command Syntax
The following CLI syntax applies to Media QoS KPI Profile.
% set profiles media mediaQosKpiProfile <profile_name>
profileActive <disable|enable>
rFactor <disable|enable>
rFactorThreshold <1-100>
Command Parameters
TABLE 7 18 Media QoS KPI Profile Parameters
Parameter
Length/
Range Description
mediaQosKpiProfile
1-23
The name of the Media QoS KPI Profile.
profileActive
N/A
Use this flag to enable/disable the Media QoS KPI profile.

disable (default)
enable
rFactor
N/A
Use this flag to enable/disable R-Factor voice quality

measurement flag.
disable (default)
enable
rFactorThreshold
0-100
The R-Factor threshold utilization value, as a percentage. If the

calculated R-Factor value goes below the set threshold, the trunk
group route is considered bad and filtered out. (default = 70).
Command Example
This example creates a Media QoS KPI Profile named MQOS-Test, enables the
profile, enables R-Factor measurement and sets R-Factor threshold to 75%.
In the next two commands, the profile is associated with the DEFAULT_SIP IP
Signaling Profile and QoS-based routing is enabled.
% set profiles media mediaQosKpiProfile MQOS-Test
profileActive enable rFactor enable rFactorThreshold 75
7 60

CLI Reference Guide

Media
Profiles
% show details profiles media mediaQosKpiProfile MQOS-Test

profileActive
enable;
rFactor
enable;
rFactorThreshold 75;
% set profiles signaling ipSignalingProfile DEFAULT_SIP
egressIpAttributes mediaQosKpiProfile MQOS-Test
egressIpAttributes flags qosBasedRouting enable
Packet Service Profile

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.
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
<unique_profile_name>
aal1PayloadSize <0-999>
codec <codecEntry1-codecEntry4> <codec>
dataCalls
initialPlayoutBufferDelay <5-50>
packetSize <10|20|30|40>
preferredRtpDataPayloadType <0-127>
flags
digitDetectSendEnabled <disable|enable>
disallowDataCalls <disable|enable>
interworkDtmfWithoutTranscoding <disable|enable>
useDirectMedia <disable|enable>
validatePeerSupportForDtmfEvents <disable|enable>
honorRemotePrecedence <disable|enable>
7 61
CLI Reference Guide

Profiles
Media
mediaPacketCos <0-7>
codecsAllowedForTranscoding
otherLeg <amr|efr|evrc|g711a|g711u|g722|g726|g729|
g7221|g7222|g7231|ilbc|t38>
thisLeg
<amr|efr|evrc|g711a|g711u|g722|g726|g729|g7221|
g7222|g7231|ilbc|t38>
conditionsInAdditionToNoCommonCodec
differentDtmfRelay <disable|enable>
differentPacketSize <disable|enable>
differentSilenceSuppression <disable|enable>
honorOfferPreference <disable|enable>
transcode <conditional|determinedByPspForOtherLeg|
only|transcoderFreeTransparency
peerAbsenceAction <none|peerAbsenceTrap|
peerAbsenceTrapAndDisconnect>
preferredRtpPayloadTypeForDtmfRelay <0-128>
rtcpOptions rtcp <disable|enable>
secureRtpRtcp
cryptoSuiteProfile <profile_name>
flags
allowFallback <disable|enable>
enableSrtp <disable|enable>
sendRoutePSPPrecedence <disable|enable>
silenceFactor <0-50>
silenceInsertionDescriptor
g711SidRtpPayloadType <0-127>
heartbeat <disable|enable>
t38
dataRateManagementType <type1LocalGenerationOfTcf|
type2TransferOfTcf>
ecm ecmPreferred <disable|enable>
lowSpeedNumberOfRedundantPackets <0|1|2>
maxBitRate <2.4Kbits_s|4.8Kbits_s|9.6Kbits_s|
14.4Kbits_s>
numberOfRedundantPackets <0|1|2>
typeOfService <0-999>
videoCalls
audioOnlyIfVideoIsPrevented <disable|enable>
maxVideoBandwith <0-2048>
7 62

CLI Reference Guide

Media
Profiles
videoBandwidthReductionFactor <0-100>
voiceInitialPlayoutBufferDelay <1-50>
Command Parameters
TABLE 7 19 Packet Service Profile Parameters
Parameter
Length/
Range Description
N/A
Specifies a unique identifier (name) for packet service profile.

You can define any name or use Default as the parameter.
aal1PayloadSize
0-999
The ATM Adaption Layer Type 1 (AAL-1) payload size

(default = 47).
codec
N/A
Defines the codec entries and priorities.

codecEntry1 This attribute specifies the codec entry with
a priority of 1. For each codec entry, select the desired
codec. Codec IDs available by default are:
G711-DEFAULT
G711SS-DEFAULT
G723-DEFAULT
G723A-DEFAULT
G726-DEFAULT
G729A-DEFAULT
G729AB-DEFAULT
a priority of 2. For each codec entry, select the codec entry
ID as specified in codecEntry1.
ID as specified in codecEntry1.
ID as specified for codecEntry1.

7 63
CLI Reference Guide

Profiles
Media
TABLE 7 19 Packet Service Profile Parameters (Continued)

Parameter
Length/
Range Description
dataCalls
N/A
Data calls pertaining to restricted or unrestricted digital data.

initialPlayoutBufferDelay Used for G.711 only.
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 (voiceInitialPlayoutBufferDelay) 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. (range: 5-50 / default = 50).
packetSize The maximum data packet size (Kilobits).
10|20|30|40
preferredRtpDataPayloadType The RTP Payload
Type included in the RTP header of the data packet.
flags
N/A
Defines PSP flags.

digitDetectSendEnabled Flag to specify whether digit
detection is enabled on digits sent to the network.
disable (default)
enable
disallowDataCalls Enable flag to disallow data calls.
disable (default)
enable
interworkDtmfWithoutTranscoding Enable flag to
interwork DTMF with out-of-band RFC2833 without using
transcoding.
disable (default)
enable
useDirectMedia Enable flag to use direct media as
needed.
disable (default)
enable
7 64

CLI Reference Guide

Media
Profiles

Parameter
Length/
Range Description
flags (continued)
N/A
validatePeerSupportForDtmfEvents Flag to
validate peer support for DTMF events. Enable this flag for all
peer devices that support RFC 4733.
enable 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 (with no other combination or subset of events),
SBC 5x00 forwards the events in the egress leg to this
peer using the named event RTP payload. When 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.
disable (default) 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.
honorRemotePrecedence
N/A
Flag to set precedence of audio encoding priority order of the

local packet service profile 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) Applies precedence to local audio
encoding priority order, local Secure RTP/RTCP settings and
crypto suite priority order.
enable Applies precedence to the remote peers audio
encoding priority order. For ingress call legs, also applies
precedence to remote peer's Secure RTP/RTCP settings and
crypto suite priority order.
mediaPacketCos
0-7
Specifies 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. (default = 0 which is interpreted as best effort).

7 65
CLI Reference Guide

Profiles
Media

Parameter
Length/
Range Description
N/A
Use this object to define the packet-to-packet control

parameters:
codecsAllowedForTranscoding Use this parameter to
specify codecs allowed for transcoding, and which leg to
apply it to.
otherLeg <codec> (see codec list below)
thisLeg <codec> (see codec list below)
conditionsInAdditionToNoCommonCodec The SBC
5x00 performs transcoding when any of the specified
conditions are met, including no common codec on ingress
and egress legs.
differentDtmfRelay Enable this flag to perform
transcoding when the ingress and egress call legs use
different DTMF relay methods.
disable (default)
enable
differentPacketSize Enable this flag to perform
transcoding when the ingress and egress call legs use
different packet sizes.
disable (default)
enable
differentSilenceSuppression Enable this flag to
perform transcoding when the ingress and egress call legs
use different silence suppression methods.
disable (default)
enable
honorOfferPreference (default) Enable this flag to
apply this packet service profile to either ingress or egress
call leg. The codec offer list of the remote peer is given
preference (default is disable). This option is available
only when Transcode=Conditional.
transcode Transcode options:
conditional (default)
determinedByPspForOtherLeg
only
transcoderFreeTransparency
Codecs:
amr efr evrc g711a g711u g722
g7221 g7222 g7231 ilbc t38
7 66
g726
g729

CLI Reference Guide

Media
Profiles

Parameter
Length/
Range Description
peerAbsenceAction
N/A
Specifies action to take when mediaPeerInactivity timer

expires.
none (default) Inactivity detection is disabled.
peerAbsenceTrap Choose this option to generate a trap
if RTP inactivity is detected.
peerAbsenceTrapAndDisconnect Choose this option
to generate a trap and tear down the call if RTP inactivity is
detected.
preferredRtpPayloadTyp 0-128
eForDtmfRelay
rtcpOptions
N/A
The preferred RTP payload type to be set in the RTP header of

audio packets for this encoding. (default = 128).
Use this object with rtcp parameter to specify 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:
disable (default)
enable RTCP is used for the call. The actions are:
packetLossAction Packet loss action to take when
packet threshold is exceeded:
- none Take no action.
- packetLossTrap Generate trap.
- packetLossTrapAndDisconnect Generate trap
and disconnect.
packetLossThreshold Use this parameter to set
packet loss threshold value. This parameter is required if
RTCP is enabled. (range: 0-32767 / default = 0).
terminationForPassThrough Specifies RTCP
termination behavior for pass-through calls.
- disable (default) RTCP is relayed between the
end points for pass-through calls.
- enable RTCP sessions for each leg are terminated
by the SBC 5x00.
secureRtpRtcp
N/A
Specifies whether secure RTP Real Time Control Protocol

(SRTP) is enabled for the call:
cryptoSuiteProfile A unique identifier for the crypto
suite profile.
flags
allowFallback Enable to allow fallback to standard
RTP/RTCP when crypto attribute negotiation fails.
- disable (default)
- enable
enableSrtp Use flaog to enable secure RTP/RTCP.
- disable (default)
- enable

7 67
CLI Reference Guide

Profiles
Media

Parameter
Length/
Range Description
sendRoutePSPPrecedence N/A
Use this flag to allow audio encoding order preference in

outgoing messages only.
disable (default)
enable
silenceFactor
N/A
silenceInsertionDescri N/A
ptor
The percentage of call time that silence is expected. This

parameter is used to reduce expected call bandwidth. (range: 050 / default = 40).
Use this object to define the Silence Insertion Descriptor (SID)
attributes.
g711SidRtpPayloadType Specifies the G.711 Silence
Insertion Descriptor (SID) RTP payloadType.
heartbeat By default, this flag is enabled to allow SID
packets to be sent within a minimal interval during a silence
period (at least one SID packet must be sent within a SID
maximum packet time frame).
disable
enable (default)
t38
N/A
Use this object to specify T.38 data rate attributes using

following parameters:
dataRateManagementType:
type1LocalGenerationOfTcf Type 1 data rate
management requires that the Training Check Frame
(TCF) training signal is 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 optionally used with UDP
implementations.
type2TransferOfTcf (default) Type 2 data rate
management requires that the TCF is 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 Use this flag to allocate DSP resources, when
available, for T.38 Error Correction Mode (ECM) calls.
disable (default) use normal resource allocation.
enable
lowSpeedNumberOfRedundantPackets This field
specifies the number of redundant IFP messages sent in a
UDP packet for T.38 low speed fax transmission, and applies
only if the T.38 error correction type is redundancy.
7 68

CLI Reference Guide

Media
Profiles

Parameter
Length/
Range Description
t38 (continued)
N/A
maxBitRate Use this object to select 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.27ter fall-back
mode.
4.8Kbits_s For modem type ITU-T V.27ter.
9.6Kbits_s For modem types ITU-T V.27ter and V.29.
14.4Kbits_s (default) For modem types ITU-T
V.27ter, V.29, and V.17. This setting is used to constrain
the type of modem modulation schemes.
numberOfRedundantPackets Use this parameter for
high-speed fax relay to specify the number of redundant
Internet Facsimile Protocol (IFP) messages sent in a User
Datagram Packet (UDP) for fax transmission.
typeOfService
0-999
Use this object to identify the Type of Service (TOS) parameters

to be provided in the IP header for voice packets. Default value
is 0.
videoCalls
N/A
Use this object to define video call parameters.

audioOnlyIfVideoIsPrevented By default, this flag is
enabled to allow call to continue with the audio only portion if
the video cannot be established for any reason.
disable
enable (default)
maxVideoBandwith Maximum bandwidth in Kbps utilized
by the video stream. (range: 0-2048 / default = 0).
videoBandwidthReductionFactor The rate in which
the maximum video bandwidth is reduced when IP resource
allocation is performed. (range: 0-100 / default = 0).
voiceInitialPlayoutBuf 1-50
ferDelay
The delay (in milliseconds) by the initial playout buffer required

to absorb the maximum expected data packet delay across the
network. Must be in increments of 1 ms. (default = 10).

7 69
CLI Reference Guide

Profiles
Media
Command Example
% show profiles media packetServiceProfile
packetServiceProfile DEFAULT {
dataCalls {
preferredRtpDataPayloadType 56;
initialPlayoutBufferDelay
50;
packetSize
20;
}
silenceFactor
40;
typeOfService
0;
voiceInitialPlayoutBufferDelay
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 "";
}
}
7 70

CLI Reference Guide

Media
Profiles
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 SBC 5x00 to
use to 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 (LRBT) for the SBC 5x00,
which the SBC 5x00 plays to callers upon receipt of an alert indication without a
media stream or without an indication of in-band tones.
Command Syntax
% set profiles media toneAndAnnouncementProfile <profile name>
localRingBackTone
signalingTonePackageState <disable|enable>
flags
useThisLrbtForEgress <disable|enable>
useThisLrbtForIngress <disable|enable>
makeInbandToneAvailable <disable|enable>
precedence <higher|lower>
signalingTonePackage <name>
toneAndAnnouncement
announcementPackageState <disable|enable>
announcementPackage <name>
override <disable|enable>
sigTonePackage <name>

7 71
CLI Reference Guide

Profiles
Media
Command Parameters
TABLE 7 20 Tone and Announcement Profile parameters
Parameter
Length/
Range Description
NA
Use this object to configure the Tone and Announcement

Profile.
localRingBackTone
NA
This parameter configures the LRBT settings.

flags Flags to enable/disable LRBT for egress and
ingress trunk groups.
useThisLrbtForEgress Enable flag to use
LRBT for egress trunk group.
disable (default)
enable
useThisLrbtForIngress - Enable flag to use
LRBT for egress trunk group.
disable (default)
enable
makeInbandToneAvailable Enable flag to insert
an in-band tone indicator (OBCI in the case of ISUP)
in a backward message (for example, ACM) when
playing local ring back.
disable (default)
enable
precedence Set this parameter when both the
ingress and egress trunk groups have a LRBT
associated with them and you want to specify which
one has priority over the other.
higher
lower (default)
signalingTonePackage Enter the signaling tone
package to use for calls associated with the specified
ingress and/or egress trunk group(s).
signalingTonePackageState Enable flag to
configure a signaling tone package.
disable (default)
enable
7 72

CLI Reference Guide

Media
Profiles
TABLE 7 20 Tone and Announcement Profile parameters

Parameter
Length/
Range Description
toneAndAnnouncement
NA
This parameter configures the Tone and Announcement

package.
announcementPackageState Enable flag to
configure the announcement package.
disable (default)
enable
announcementPackage Enter the announcement
package to use for calls associated with the specified
ingress and/or egress trunk group(s).
override When profiles are assigned to both
ingress and egress trunk groups, enable this flag to
override settings and use this specific announcement
profile for both call legs.
disable (default)
enable
sigTonePackage Enter the signaling tone package
to use for calls associated with the specified ingress
and/or egress trunk group(s).
Tone Package
This object 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 toneAndAnnouncementProfile in the Packet Service Profile.
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

7 73
CLI Reference Guide

Profiles
Media
Command Syntax
% set profiles media tonePackage <package name>
packageId <100-248>
toneType <user name of tone type, e.g. dial, busy
reorder, etc.>
toneProfile <profile name>
Command Parameters
TABLE 7 21 Tone Package Parameters
Parameter
Length/
Range Description
tonePackage
N/A
packageId
100-248 The tone package identifier defined by the PSX/ERE.
Use this object to configure a tone package and define a

set of call progress tones for a given country or carrier.
NOTE: Package IDs 0-99 are reserved for seed
data.
Use this parameter to select elements to bind tone types
to tone profiles for a given tone package.
toneType
<user name of tone type>

toneProfile select a default tone profile, or create
a new one. Default tone profiles include:
defBusy defCallWaiting1 defCallWaiting2
defCallWaiting3 defCallWaiting4
defCpeAlerting defDial defReorder
defRing defSit1 defSit2 defSit3
Command Examples
To show seeded DEFAULT tone package:
% show profiles media tonePackage DEFAULT
packageId 1;
element busy {
toneProfile defBusy;
}
element dial {
toneProfile defDial;
}
element ring {
7 74

CLI Reference Guide

Media
Profiles
toneProfile defRing;
}
element sit1 {
toneProfile defSit1;
}
element sit2 {
}
element sit3 {
}
element reorder {
toneProfile defReorder;
}
element cpeAlerting {
toneProfile defCpeAlerting;
}
element callWaiting1 {
toneProfile defCallWaiting1;
}
}
}
To delete a tone package:
% delete profiles media tonePackage custTonePkg

7 75
CLI Reference Guide

Profiles
Media
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
Dual Tone
Modulated Tone
Composite Tone
For more information on Tone Profile and signal characteristics, refer to 55005335 SBC 5x00 Operations Guide.
Command Syntax
To create custom tone profile:
% set profiles media toneProfile <profile name>
break1 <-1 to 8000>
break2 <-1 to 8000>
break3 <-1 to 8000>
dualTone
tone1Frequency <0-3999, in Hertz>
tone1Power <-50-3, in dBm>
tone2Frequency <0-3999, in Hertz>
tone2Power <-50-3, in dBm>
generationMethod <compositeTone|dualTone|modulatedTone|
singleTone>
make1 <-1-8000, in milliseconds>
repeat <#>
repeat1 <#>
repeat2 <#>
repeat3 <#>
7 76

CLI Reference Guide

Media
Profiles
Command Parameters
TABLE 7 22 Tone Profile Parameters
Parameter
Length/
Range Description
toneProfile
N/A
break1
-1-8000 Use this parameter to specify duration of the first off cadence, in
Use this object to define tone profiles for the node. Enter a user
name, or select a default profile.
If duration = 0, silence is not generated between the on cadences.

If duration = -1, silence is generated continuously.
break2
-1-8000 Use this parameter to specify duration of the second off cadence, in
break3
-1-8000 Use this parameter to specify duration of the third off cadence, in
dualTone
N/A
Use this parameter to configure dual tone attributes.

tone1Frequency Tone 1 frequency, in Hertz. <range: 0-3999 /
default = 440>
tone1Power Tone 1 power, in dBm. <range: -50-3 /
default = -13>
tone2Frequency Tone 2 frequency, in Hertz. <range: 0-3999 /
default = 0>
tone2Power Tone 2 power, in dBm. <range: -50-3 /
default = 0>
generationMethod
This parameter determines the generation method for the tone. The
value is specified at object creation time and cannot be modified
thereafter.
make1
compositeTone
dualTone (default)
modulatedTone
singleTone
-1-8000 Use this parameter to specify duration of the first on cadence, in

If make1 = 0, duration of first on cadence = 0 milliseconds.
If make1 = -1, the tone plays continuously.
make2
-1-8000 Use this parameter to specify duration of the second on cadence, in


7 77
CLI Reference Guide

Profiles
Media
TABLE 7 22 Tone Profile Parameters (Continued)

Parameter
Length/
Range Description
-1-8000 Use this parameter to specify duration of the third on cadence, in
make3

repeat
N/A
Number of overall cadence cycles to generate. (default = 0).

If repeat = 0, the tone pattern repeats indefinitely.
repeat1
N/A
Number of cadence 1 cycles to generate. (default = 1)
repeat2
N/A
repeat3
N/A
Command Examples
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.

defCpeAlerting
defDial
defReorder
defRing
defSit1
defSit2
defSit3
fccBusy
fccDial
fccRingback
Possible match completions:
7 78
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

CLI Reference Guide

Media
Profiles
compositeTone
attributes.
Configuration of conposite tone
dualTone
attributes.
Configuration of dual tone
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
generate.
Number of cadence 1 cycles to
repeat2
generate.
repeat3
generate.
singleTone
attributes.
Configuration of single tone
To delete the custom tone profile crearted:

% delete profiles media toneProfile <toneProfile>

7 79
CLI Reference Guide

Profiles
Security
Security
The Security object supports the following profiles:
"Crypto Suite Profile" on page 7 80

"Key Management Protection Profile" on page 7 82
"IPSec Protection Profile" on page 7 84
"TLS Profile" on page 7 86
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-sha1-80."
Secure RTP is requested by the presence of RTP/SAVP or RTP/SAVPF in the m=
line.
The appropriate crypto suite profile may also include valid combinations of the
following session parameters:
unauthenticatedSRTPSignals that the SRTP packet payloads are not

authenticated.
unencryptedSRTPSignals that the SRTP packet payloads are not

encrypted.
unencryptedSRTCPSignals 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.
7 80

CLI Reference Guide

Security
Profiles
Command Syntax
% set profiles security cryptoSuiteProfile <profile name>
entry <priority>
cryptoSuite <cryptoSuite>
sessionParameterFlags <sessionParameterFlags>
% show profiles security cryptoSuiteProfile
<cryptoSuiteProfile>
% delete profiles security cryptoSuiteProfile
<cryptoSuiteProfile>
Command Parameters
TABLE 7 23 Crypto Suite Profile Parameters
Parameter
Length/
Range Description
cryptoSuiteProfile
1-23
The name of the Crypto Suite Profile.
entry
N/A
Use this parameter to specify the priority of this profile.

(default = 1).
cryptoSuite
N/A
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
none
sessionParameterFlags
N/A
Use this parameter to specify authentication/encryption settings

of the session parameter flags.
unauthenticatedSRTP Enable to signal that the SRTP
packet payloads are not authenticated.
disable (default)
enable
unencryptedSRTCP Enable to signal that the SRTCP
packet payloads are not encrypted.
disable (default)
enable
unencryptedSRTP Enable to signal that the SRTP packet
payloads are not encrypted.
disable (default)
enable

7 81
CLI Reference Guide

Profiles
Security
Command Example
% show profiles security cryptoSuiteProfile
cryptoSuiteProfileTest
entry 1
{
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 <profile name>
algorithms <encryption|integrity>
dpdInterval <interval #>
saLifetimeTime <1200-1000000 seconds>
7 82

CLI Reference Guide

Security
Profiles
Command Parameters
TABLE 7 24 Key Management Protection Profile Parameters
Parameter
Length/
Range
1-23
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. The SBC 5x00 uses these
properties when it forms an IPSec association with a peer.
algorithms
N/A
IPSec Protection Profile ESP protocol cipher configurations.
Description
encryption IPsec Protection Profile Encryption Cipher.

3DesCbc
aesCbc128 (default)
integrity The IPsec Protection Profile integrity Cipher.
hmacMd5
hmacSha1 (default)
dpdInterval
10-3600,
IKE Protection Profile Dead Peer Detection test interval period, in
or noDpd seconds. To disable DPD, enter noDpd. (default = 30).
saLifetimeTime
12001000000
IPSec Protection Profile SA Lifetime setting, in seconds. (default =

28,800, which equals 8 hours)
displaylevel
1-64

commands.
Command Example
% show profiles security ikeProtectionProfile
ikeProtectionProfile Test
{
saLifetimeTime 28800;
algorithms {
encryption 3DesCbc,aesCbc128;
integrity
dpdInterval
hmacSha1,hmacMd5;
45;
}
}

7 83
CLI Reference Guide

Profiles
Security
IPSec Protection 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 <profile
name>
espAlgorithms
encryption <3DesCbc|aesCbc128|null>
integrity <hmacMd5|hmacSha1>
saLifetimeByte <10000-4294967295 (in bytes), or
unlimited>
saLifetimeTime <1200-1000000 (in seconds)>
% show profiles security ipsecProtectionProfile <profile
name>
espAlgorithms
encryption
integrity
saLifetimeByte
saLifetimeTime
% delete profiles security ipsecProtectionProfile <profile
name>
Command Parameters
TABLE 7 25 IPSec Protection Profile Parameters
Parameter
Length/
Range
ipsecProtection 1-23
Profile
7 84
Description
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.

CLI Reference Guide

Security
Profiles
TABLE 7 25 IPSec Protection Profile Parameters (Continued)

Parameter
Length/
Range
Description
espAlgorithms
N/A
The IPSec Protection Profile ESP protocol cipher configurations.

encryption The IPsec Protection Profile Encryption Cipher.
3DesCbc
aesCbc128 (default)
null
integrity The IPsec Protection Profile Integrity Cipher.
hmacMd5
hmacSha1 (default)
saLifetimeByte
100004294967295
IPSec Protection Profile SA Lifetime setting in number of bytes.

(default = unlimited)
saLifetimeTime
12001000000
The SA Lifetime setting, in seconds. This is the maximum interval

that any one Security Association will be maintained before
possible re-keying. 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. (default = 28800, which
corresponds to 8 hours)
displaylevel
1-64
Command Example
% show profiles security ipsecProtectionProfile
AesSha1IpsecProfile
{
saLifetimeTime 28800;
saLifetimeByte unlimited;
espAlgorithms
{
encryption null,3DesCbc,aesCbc128;
integrity
hmacSha1;
}
}

7 85
CLI Reference Guide

Profiles
Security
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 are
sent in plain text over TCP or UDP connections; Secure SIP is a security measure
that uses TLS, the successor to the Secure Sockets Layer (SSL) protocol.
To add a TLS protection-level policy, you create a TLS Profile and configure each
of the parameters. The 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 <profile name>
allowedRoles <clientandserver|server>
appAuthTimer <1-60 seconds>
authClient <false|true>
cipherSuite1 <nosuite|rsa-with-3des-ede-cbc-sha|rsa-withaes-128-cbc-sha|rsa-with-null-sha>
clientCertName <name>
handshakeTimer <1-60 seconds>
serverCertName <name>
sessionResumpTimer <0-86400 seconds>
7 86

CLI Reference Guide

Security
Profiles
Command Parameters
TABLE 7 26 TLS Profile Parameters
Parameter
Length/
Range
Description
tlsProfileName
1-23
Name assigned to this Transport Layer Security (TLS) profile.
allowedRoles
N/A
Allowed TLS roles for this TLS profile.

clientandserver (default) Choose to select both a TLS
client and server role, 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
1-60
The higher layer authentication timer in seconds. (default = 5).
authClient
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).
false
true (default)
cipherSuite1
N/A
Use this parameter to specify the first TLS Cipher Suite choice for
this profile.
nosuite
rsa-with-3des-ede-cbc-sha
rsa-with-aes-128-cbc-sha (default)
rsa-with-null-sha
NOTE: The first component (rsa) of the TLS cipher suite
name identifies the authentication mechanism used in the
TLS Handshake protocol. The middle components (aes128) identify the confidentiality cipher and mode used for
the TLS Record protocol. The last component (SHA)
identifies the integrity cipher used for the TLS Record
protocol.
cipherSuite2
N/A
Use this optional parameter to specify the second TLS Cipher Suite
choice for this profile.
cipherSuite3
N/A
Use this optional parameter to specify the third TLS Cipher Suite
choice for this profile.
clientCertName
1-23
nosuite (default)
rsa-with-aes-128-cbc-sha
rsa-with-null-sha
nosuite (default)
rsa-with-aes-128-cbc-sha
rsa-with-null-sha
The name of the default Client Certificate to be used by this TLS

profile, created using the SECURITY PKI configuration object.

7 87
CLI Reference Guide

Profiles
Security
TABLE 7 26 TLS Profile Parameters (Continued)

Parameter
Length/
Range
Description
handshakeTimer
1-60
The time (in seconds) in which the TLS handshake must be

completed. The timer starts when the TCP connection is
established. (default = 5)
serverCertName
1-23
Specifies the name of the Server Certificate to be used by this TLS

profile, created using the SECURITY PKI configuration object.
sessionResumpTimer
0-86400 The TLS session resumption period (in seconds) for which cached
sessions are retained. 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. (default = 3600)
Command Example
% show profiles security tlsProfile TestingTLS
appAuthTimer
5;
handshakeTimer
5;
sessionResumpTimer 3590;
7 88
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;

CLI Reference Guide

Services
Profiles
Services
The Services object supports the following profiles:
"Class of Service Profile" on page 7 89

"Dynamic Blacklist (DBL) Policer Profile" on page 7 91
"Disconnect Signaling Sequence Profile (SSP)" on page 7 93
"Disconnect Treatment Profile" on page 7 95
"Emergency Call Profile" on page 7 97
"Path Check Profile" on page 7 98
"SIP ARS Profile" on page 7 100
"SIP Security Profile" on page 7 103
Class of Service Profile

A Class of Service (CoS) Profile is a classification of common services shared by
a group of entities (trunk groups, carriers, subscribers) giving them particular
rights and privileges. CoS profiles can be provisioned using a number of call type
filters and screening scripts.
The SBC 5x00 is shipped with a number of pre-defined CoS profile 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 <CoS name>
blocking
entry <called number, country, call type>
service <disable|enable>
nonSubscriberCallTypeFiltering
carrierCutThrough|internationalOperator|
internationalType|ipVpnService|localOperator|
longDistanceOperator|mobile|nationalOperator|
nationalType|otherCarrierChosen|private|test|
transit|userName
screening script
BLOCKING|DEFAULT_TERMINATING|NONSUB_DENY|
NO_ROUTES_FOUND|SCREENING|TANDEM

7 89
CLI Reference Guide

Profiles
Services
Command Parameters
TABLE 7 27 Class of Service Parameters
Parameter
Length/
Range Description
classOfService
N/A
blocking
N/A
A unique identifier for Class Of Service.

Parameters associated with blocking service.
entry <called# countryCode callType> Enter both
the called number, country code and call type, separated by a
space (callType default is nationalOperator) against which
the blocking service applies. To block any number in the
country code, use double quotes (see example below).
service Flag to enable/disable the blocking service.
disable (default)
enable
nonSubscriberCallType N/A
Filtering
Use this parameter to specify the type of calls allowed for nonsubscriber call routing. By default, all options are selected.
screening script
N/A
Use this parameter to select the screening script to use with this
class of service.
7 90
carrierCutThrough
internationalType
ipVpnService
localOperator
mobile
nationalOperator
nationalType
otherCarrierChosen
private
test
transit
userName
BLOCKING
DEFAULT_TERMINATING
NONSUB_DENY
NO_ROUTES_FOUND
SCREENING
TANDEM

CLI Reference Guide

Services
Profiles
Command Example
The following example accomplishes the following actions:
1. Creates and enables a class of service called BLOCK_COUNTRY_CODES

to block two specific international country codes (20 and 27).
2. Assigns the class of service to a trunk group named APBX5TEST.

% set profiles services classOfService BLOCK_COUNTRY_CODES
blocking service enable entry "" 20 callType
internationalType
% set profiles services classOfService BLOCK_COUNTRY_CODES
blocking entry "" 27 callType internationalType
% show profiles services classOfService BLOCK_COUNTRY_CODES
blocking {
service enable;
entry "" 20 {
callType internationalType;
}
entry "" 27 {
callType internationalType;
}
}
% set addressContext default zone zonePublicTrunking
sipTrunkGroup APBX5TEST policy services classOfService
BLOCK_COUNTRY_CODES
Dynamic Blacklist (DBL) Policer Profile

The DBL Policer Profile is a collection of DBL policers applied to restrict traffic
from endpoints/peers based on specific events, such as receiving excessive traffic
from these entities. Dynamic blacklisting is used more as a mechanism to deal
with misbehaving entities rather than preventing malicious attacks.
Command Syntax
% set profiles services dblProfile <DBL Profile name>
rule <rule name>
action <blacklist|watch>
actionEffectivePeriod <60-86400 seconds>
event <badSipMessage|epCacAggrReject|
sipRegistrationFailure>
eventPeerDayThreshold <0-86400>
7 91
CLI Reference Guide

Profiles
Services
type <sip>
Command Parameters
TABLE 7 28 DBL Profile Parameters
Parameter
Length/
Range
Description
dblProfile
1-23
The administrative name of the DBL profile.
rule
N/A
Specifies the DBL rule name within a DBL profile.

Additional parameters are shown below:
action The action to take when a specified event meets
the criteria:
blacklist
watch
actionEffectivePeriod The DBL action enforcement
period (in seconds) the DBL policer entry remains effective.
(range: 60-86400 / default = 60)
event The type of event for this DBL rule.
badSipMessage
epCacAggrReject
sipRegistrationFailure
Each of the above events include two additional arguments:
eventPerDayThreshold number of events per day
used as fillrate of token bucket policer (value: 0-86400,
default = 0)
eventPerDayThreshold The number of events per day
which is used as fillrate of token bucket policer. (range: 086400 / default = 0)
state The administrative state of this rule.
disabled (default)
enabled
state
N/A
The administrative state of the DBL profile.

disabled (default)
enabled
type
7 92
N/A
The type of application being monitored (automatically defaults

to sip).

CLI Reference Guide

Services
Profiles
Command Examples
The following example sets DBL profile named DBP-1 with a rule (named
RULE-1) to watch SIP endpoints every 60 seconds for a bad SIP message. If the
number of events per day to be used as a token bucket policer fillrate is 13.
% set profiles services dblProfile DBP-1 rule RULE-1 action
watch actionEffectivePeriod 60 event badSipMessage
eventPeerDayThreshold 13 state enabled
% show profiles services dblProfile DBP-1
rule RULE-1 {
state
enabled;
event
badSipMessage;
action
watch;
eventPerDayThreshold
13;
actionEffectivePeriod 60;
Disconnect Signaling Sequence Profile (SSP)

This object creates a Disconnect Signaling Sequence Profile defining a set of
signaling sequences necessary to perform disconnect treatment of a call. The
Disconnect SSP is populated by creating and configuring individual signaling
sequences.
Command Syntax
% set profiles services disconnectSignalSequenceProfile
<profile name>
ssp <ssp0 - ssp32>
param1 <first param. name>
param2 <second param. name>
position <0-255>
token <clear|delay|exec|playAnn|playTone>

7 93
CLI Reference Guide

Profiles
Services
Command Parameters
TABLE 7 29 Disconnect SSP Parameters
Parameter
Length
/Range Description
disconnectSignalSequence N/A
Profile
The Disconnect Signaling Sequence Profile name.
ssp
0-32
A unique signaling sequence in the format ssp#, where # is

an index value (ex. ssp1)
param1
N/A
A text field used to pass parameter #1 to the Disconnect SSP

signaling sequence that is being configured. This parameter
is dependent on the Disconnect signaling token used in this
signaling sequence.
param2
N/A
A text field used to pass parameter #2 to the Disconnect SSP

signaling sequence that is being configured. This parameter
is dependent on the Disconnect signaling token used in this
signaling sequence.
position
0-255
The position in Disconnect SSP at which to execute this step.

This parameter allows you to insert steps into the middle of a
Disconnect SSP without needing to renumber the index of
the subsequent SSP steps. Positions begin with zero, so to
insert a step in front of step 3 in the current Disconnect SSP,
you declare a position of 2. (default = 0).
state
N/A
The administrative state of this Disconnect SSP. To

reconfigure or delete the profile, set to disabled.
disabled (default)
enabled
token
N/A
This parameter specifies the token, or action to perform.

clear Initiate call clearing procedures on the call. The
disconnect reason is an integer specified in param1.
delay Delay further execution of the Disconnect SSP
for the interval (in milliseconds) specified in param1.
exec Start execution of the SSP specified in param1.
playAnn Play the announcement specified in param1.
The param1 value must match a previously established
announcement number (see "Announcement Package" on
page 7 47).
playTone Play the tone specified in param1 for the
duration specified in param2. The param1 value must
match a defined tone type (see "Tone Package" on
page 7 73). If param2 is 0, the tone plays indefinitely
(or until it completes on its own). Execution of the
Disconnect SSP is suspended until the tone completes.
7 94

CLI Reference Guide

Services
Profiles
Command Examples
The following command creates and enables an SSP called ssp1 which is set to
position 1.
% set profiles services disconnectSignalSequenceProfile
DSSP-1 ssp ssp1 state enabled position 1 token playTone
param1 callWaiting1 param2 0
% show profiles services disconnectSignalSequenceProfile
DSSP-1
ssp ssp1 {
position 1;
token
playTone;
param1
callWaiting1;
param2
0;
state
enabled;
Disconnect Treatment Profile

SBC 5x00 applies disconnect treatment to the ingress party specified by the
Signaling Sequence Profile (SSP). This SSP is derived from the SCP disconnect
treatment profile (DTP) and disconnect treatment indicator provided by the policy
server in a trigger response. The DTP must be explicitly configured on the SBC
5x00. The existing disconnect reason is still forwarded to the ingress party
immediately after the disconnect treatment (if applicable) is applied. The
disconnect reason can be SCP or egress party initiated.
Command Syntax
% set profiles services disconnectTreatmentProfile <profile
name>
reason <1-255>
disconnectSSP <DSSP profile name>

7 95
CLI Reference Guide

Profiles
Services
Command Parameters
TABLE 7 30 Disconnect Treatment Profile Parameters
Length/
Range Description
Parameter
disconnectTreatment
Profile
N/A
The Disconnect Treatment Profile name.
reason
1-255
The call disconnect reason code to associate with a particular

Disconnect SSP.
See SBC 5x00 Operations Guide for call disconnect codes.
N/A
disconnectSSP
The name of the Disconnect SSP to execute for the given

Disconnect Treatment Profile and disconnect Reason code.
Command Example
The following example creates a Disconnect Treatment Profile named DTP-1
with a reason code of 16 (normal call clearing), and assigns disconnect SSP
DSSP-1 to this profile so that when this profile runs it will execute DSSP-1.
% set profiles services disconnectTreatmentProfile DTP-1
reason 16 disconnectSSP DSSP-1
% show profiles services disconnectTreatmentProfile
disconnectTreatmentProfile DTP-1 {
reason 16 {
disconnectSSP DSSP-1;
}
}
7 96

CLI Reference Guide

Services
Profiles
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
% set profiles services emergencyCallProfile <profile name>
cpc <none|priority>
prefix1 <firstprefix>
prefix2 <secondprefix>
prefix3 <thirdprefix>
urnPrefix <prefix>
xemg <disabled|enabled>
Command Parameters
TABLE 7 31 Emergency Call Profile Parameters
Parameter
Length/
Range Description
emergencyCallProfile 1-23
N/A
cpc
The emergency call profile name.

This parameter controls the SBC 5x00 behavior for whether to
use SIP cpc=priority as emergency call indicator.
none (default)
priority
prefix1
0-15
Alphanumeric string. An incoming SIP call is classified as an

emergency call if the called number matches this prefix.
(default is )
prefix2
0-15

(default is )
prefix3
0-15

(default is )
urnPrefix
N/A
Emergency prefix URN. For example, service:sos or

service:sos.police, where police is a subservice.
xemg
N/A
Use this flag to determine whether SIP X-EMG header should be

accepted as an emergency call indicator.
disabled (default)
enabled

7 97
CLI Reference Guide

Profiles
Services
Command Example
The following example creates an Emergency Call Profile named EmergCall-1,
and specifies to use cpc=priority as emergency call indicator. Also, 911 is set as
prefix1 any incoming call with a prefix of 911 is classified as an emergency call.
% set profiles services emergencyCallProfile EmergCall-1 cpc
priority prefix1 911
% show profiles services emergencyCallProfile EmergCall-1
prefix1 911;
cpc
priority;
Path Check Profile

The Pathcheck profile specifies the conditions that constitute a connectivity
failure, and in the event of such a failure, the conditions that constitute a
connectivity recovery. See the SBC 5x00 Applications Guide for details.
NOTE
After updating a Path Check Profile, you must disable and re-enable the
profile for the change to take effect.
Command Syntax
% set profiles services pathCheckProfile <profile name>
protocol sipOptions
recoveryCount <1-10>
replyTimeoutCount <1-10>
sendInterval <1-600>
Command Parameters
TABLE 7 32 Path Check Profile Parameters
Parameter
Length/
Range Description
pathCheckProfile
1-23
protocol
N/A
The name of the Path Check Profile.

The ping protocol type used.
sipOptions (default)
recoveryCount
1-10
replyTimeoutCount 1-10
7 98
The number of consecutive successful responses to occur before

removing the endpoints from the Blacklist. (default = 6)
The number of consecutive timeouts to occur before adding the
endpoints to the Blacklist. (default = 6)

CLI Reference Guide

Services
Profiles
TABLE 7 32 Path Check Profile Parameters (Continued)

Parameter
Length/
Range Description
sendInterval
1-600
Specifies interval (in seconds) in which the PING request will be sent
out to the endpoints. (default = 60)
Command Example
This example creates a patch check profile named PCP-1 with the default ping
protocol type sipOptions, a recovery count of 7 and a send interval of 120
seconds. The reply timeout count is left at the default of 6. Next, the PCP is
assigned to defaultSigZone zone for default address context using IP address
10.20.120.21.
% set profiles services pathCheckProfile PCP-1 protocol
sipOptions recoveryCount 7 sendInterval 120
% show profiles services pathCheckProfile PCP-1
protocol
sipOptions;
sendInterval
120;
recoveryCount 7;
% set addressContext default zone defaultSigZone ipPeer
PEER-1 ipAddress 10.20.120.21 pathCheck profile PCP-1
state enabled
% show addressContext default zone defaultSigZone ipPeer
PEER-1
ipAddress 10.20.120.21;
pathCheck {
profile PCP-1;
state
enabled;

7 99
CLI Reference Guide

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 blacklisting and
recovery algorithm variants. These ARS profiles can be assigned to the services
section of a SIP trunk group to enforce the blacklisting and recovery of any SIP
peer(s) associated with the trunk group.
If no recovery algorithm is specified when configuring a SIP ARS profile, the
recovery algorithm default values are used as indicated below:
recoveryAlgProbeDuration: 1 second
recoveryAlgProbeInterval: 1 second
recoveryAlgProbeMethod: sip-options
recoveryAlgProbeNumResponses: 1
recoveryAlgTimerDuration: 1 second
recoveryAlgorithm: probe
Command Syntax
% set profiles services sipArsProfile <profile name>
blkListAlgRetryAfterType sip-503
blkListAlgTimeoutsDuration <1-3600>
blkListAlgTimeoutsNumTimeouts <1-3600>
blkListAlgTimeoutsType sip-invite
blkListAlgorithms <retryafter|timeouts>
recoveryAlgProbeDuration <1-3600>
recoveryAlgProbeInterval <1-600>
recoveryAlgProbeMethod sip-options
recoveryAlgProbeNumResponses <1-32>
recoveryAlgTimerDuration <1-3600>
recoveryAlgorithm <probe|timer>
7 100

CLI Reference Guide

Services
Profiles
Command Parameters
TABLE 7 33 SIP ARS Profile Parameters
Parameter
Length/
Range Description
sipArsProfile
1-23
The name of the SIP Address Reachability Service

profile.
blkListAlgRetryAfterType
N/A
Use to specify the SIP status code type which

includes a Retry-After value (currently, the only
supported value is sip-503).
sip-503 When a sip-503 message is received
with Retry-After field from downstream server, this
option puts that server into blacklist to prevent new
call requests (SIP INVITEs) from retransmitting,
and starts a Recovery Algorithm to recover the
server from blacklist after the duration specified in
the RetryAfter header contained in the received
SIP 503 message.
blkListAlgTimeoutsDuration
1-3600
blkListAlgTimeoutsNumTimeouts 1-3600
blkListAlgTimeoutsType
N/A
Duration (in seconds) in which the specified number

of timeouts must occur. (default = 1).
The number of timeout events for a single INVITE
transaction (including any retransmissions) before
black listing the address. (default = 1).
The timeout trigger type (currently, only sip-invite
is available):
sip-invite Use SIP INVITE messages as a
timeout trigger.
blkListAlgorithms
N/A
Identifies blacklisting algorithm to use for this ARS

Profile. Select one or both.
retryafter Use the blkListAlgRetryAfterType
(trigger) as the blacklisting criteria.
timeouts (default) Use the timeout of the
specified SIP message for blacklisting the server.
The objects blkListAlgTimeoutsType,
blkListAlgTimeoutsNumTimeouts, and
blkListAlgTimeoutsDuration must also be
specified.
recoveryAlgProbeDuration
1-3600
Duration (in seconds) in which the specified number

of responses must occur. (default = 1).
recoveryAlgProbeInterval
1-600
The probe interval value, in seconds. (default = 1).
recoveryAlgProbeMethod
N/A
Specifies the probe method (currently, only sipoptions is available).

sip-options
recoveryAlgProbeNumResponses
1-32
The number of consecutive responses to occur before

removing an entry from the black list. (default = 1).
recoveryAlgTimerDuration
1-3600
Duration (in seconds) that the IP address remains

blacklisted. (default = 1).

7 101
CLI Reference Guide

Profiles
Services
TABLE 7 33 SIP ARS Profile Parameters (Continued)

Parameter
Length/
Range Description
recoveryAlgorithm
N/A
The recovery algorithm to use once the peer is

blacklisted.
probe (default) The ARS initiates an active
ping to the blacklisted server until it gets a
response. Once the number of consecutive
responses are received as defined by the
recoveryAlgProbeNumResponses parameter,
the address is removed from the blacklist.
timer The ARS removes the entry for the
blacklist after a configured duration.
NOTE
Traffic is shared across all SBC 5x00 SCM processes. For INVITE time
outs, an IP Peer is blacklisted only when the same SCM process
reaches the configured number of INVITE timeouts within the
configured timeout duration.
For a single shot call scenario (i.e. lab testing), it may be necessary to
gather additional timeouts to see an IP Peer get blacklisted. Once the
peer is blacklisted, the same data is available across all SCM
processes.
Similarly, when a peer is not blacklisted but is in the process of being

blacklisted because of time outs, the show command to check ARS
Status may give inconsistent results depending upon the SCM process
which responds first to the command.
Command Examples
The following example configures a SIP ARS profile named ARSPROFILE1
using the various objects and parameters.
% set profiles services sipArsProfile ARSPROFILE1
blkListAlgorithms retryafter,timeouts
blkListAlgTimeoutsType sip-invite
blkListAlgTimeoutsNumTimeouts 45 blkListAlgRetryAfterType
sip-503
% set profiles services sipArsProfile ARSPROFILE1
blkListAlgTimeoutsDuration 34 recoveryAlgProbeDuration
546 recoveryAlgProbeInterval 78 recoveryAlgProbeMethod
sip-options recoveryAlgProbeNumResponses 6
recoveryAlgTimerDuration 456 recoveryAlgorithm probe
% show profiles services sipArsProfile
sipArsProfile ARSPROFILE1 {
7 102

CLI Reference Guide

Services
Profiles
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;
SIP Security Profile

The SIP Security Profile feature defines the type and behavior of security
mechanism to apply to the SBC 5x00 acting as P-CSCF.
Command Syntax
The CLI syntax to configure the SIP Security Profile is shown below:
% set profiles services sipSecurityProfile <profile name>
forceClientSecurityPref <disabled|enabled>
rejectSecUnsupportedRequest <disabled|enabled>
sipSecurityMechanism ipsec-3gpp precedence <1-65535>
Command Parameters
TABLE 7 34 SIP Security Profile Parameters
Parameter
Length
/Range Description
sipSecurityProfile
1-23
forceClientSecurityPref N/A
Security profile name.

Enable this flag to give precedence to the order of occurrence
of mechanism-name value in the "Security-Client" header
while selecting the Security Mechanism to apply.
disabled (default)
enabled

7 103
CLI Reference Guide

Profiles
Services
TABLE 7 34 SIP Security Profile Parameters (Continued)

Length
/Range Description
Parameter
rejectSecUnsupportedReq N/A
uest
Enable this flag to reject the incoming REGISTER when it

does not contain "sec-agree" header value (in Require or
Proxy-Require headers) or does not contain any supported
mechanism-name (ipsec-3gpp) in "Security-Client" header.
Use default setting disabled to process messages using
"Digest without TLS" security mechanism.
disabled (default)
enabled
sipSecurityMechanism
N/A
Identifies the list of security mechanisms supported by SBC

5x00 and the corresponding precedence level for each
security mechanism.
ipsec-3gpp
precedence <#> The precedence to assign to a
security mechanism. A lower value represents a higher
precedence (range: 1-65535).
Command Example
The following example accomplishes the following:
Creates a SIP security profile named S-PROFILE1, sets

forceClientSecurityPref and rejectSecUnsupportedRequest to enabled,
and sets SIP security mechanism ipsec-3gpp to precedence of 1.
Assign S-PROFILE1 to SIP trunk group STG-1.
% set profiles services sipSecurityProfile S-PROFILE1

forceClientSecurityPref enabled
rejectSecUnsupportedRequest enabled sipSecurityMechanism
ipsec-3gpp precedence 1
% set addressContext default zone MYZONE sipTrunkGroup STG-1
services sipSecurityProfile S-PROFILE1
7 104

CLI Reference Guide

Signaling
Profiles
Signaling
This object is used to configure the following signaling profiles:
"X-Header Profile" on page 7 105

"IP Signaling Profile" on page 7 111
"ISUP Signaling Profile" on page 7 158
"Number Globalization Profile" on page 7 203
"SCTP Profile" on page 7 209
"Signaling Profile" on page 7 212
"Signaling QoS KPI Profile" on page 7 232
"SIP Adaptor Profile" on page 7 235
"SIP/CPC Cause Code Mapping Profile" on page 7 248
X-Header Profile
X-headers are fields in the request HTTP header beginning with an X. In other
words, these fields are used for non-standard (or proprietary) additions to the
regular fields in the HTTP header.
Command Syntax
% set profiles signaling XHeaderProfile <profile_name>
P-HeaderExtensions
P-Area-Info
RecvHeader <disabled|enabled>
SendHeader <disabled|enabled>
X-Header-default-value
X-IsupMtype-ACM
X-BCI <0-4 characters, in bytes>
X-OBCI <0-2 characters, in bytes>
X-IsupMtype-ANM
P-Area-Info <0-10 characters, in bytes>
X-BCI <0-4 characters, in bytes>
X-OBCI <0-2 characters, in bytes>
X-IsupMtype-IAM
CallingPartycategory <0-2 characters, in bytes>
X-FCI <0-4 characters, in bytes>

7 105
CLI Reference Guide

Profiles
Signaling
X-NOCI <0-2 characters, in bytes>

X-HeaderExtensions
X-ATP
RecvHeader
SendHeader
X-AUT
RecvHeader
SendHeader
X-BCI
RecvHeader
SendHeader
X-CALLING-NUM
RecvHeader
SendHeader
X-CHGDelay
RecvHeader
SendHeader
X-CHGInfo
RecvHeader
SendHeader
X-CONTRACT-ADDR
RecvHeader
SendHeader
X-Carrier-Info
RecvHeader
SendHeader
X-EMG
RecvHeader
SendHeader
X-FCI
RecvHeader
SendHeader
X-FWDORIG-NUM
RecvHeader
SendHeader
X-GENERIC-NUM
RecvHeader
SendHeader
X-ISUPEvent
7 106

CLI Reference Guide

Signaling
Profiles
RecvHeader
SendHeader
X-ISUPMtype
RecvHeader
SendHeader
X-NOCI
RecvHeader
SendHeader
X-OBCI
RecvHeader
SendHeader
X-ORIGCLD-NUM
RecvHeader
SendHeader
X-REDBWDINF
RecvHeader
X-REDCAP
SendHeader
X-REDCNT
RecvHeader
SendHeader
X-REDFWDINF
SendHeader
X-TMR
RecvHeader
SendHeader
X-USI
RecvHeader
SendHeader
X-HeaderFlags
recvCfn
recvResume
recvSuspend
sendCfn
sendResume
sendSuspend
Command Parameters

7 107
CLI Reference Guide

Profiles
Signaling
TABLE 7 35 X-Header Profile Parameters

Parameter
Length/
Range Description
XHeaderProfile
N/A
Name of X-Header profile.
P-HeaderExtensions
N/A
Prescribes behavior associated with various P-Headers and

P-K headers. Currently, only one option available:
P-Area-Info
RecvHeader Enable to receive P-Area-Info header
on the ingress leg.
disabled
enabled (default)
SendHeader Enable to send P-Area-Info header on
the egress leg.
disabled
enabled (default)
X-Header-default-value
N/A
Use this object to configure X Header default values.

X-IsupMtype-ACM ACM default values.
X-BCI Allow 4 bytes of X-BCI default data
(default = 1014).
X-OBCI Allow 2 bytes of X-OBCI default data
(default = ).
X-IsupMtype-ANM ANM default values.
P-Area-Info Allow 10 bytes of P-Area-Info default
data.
X-BCI Allow 4 bytes of X-BCI default data.
(default = 0014)
X-OBCI Allow 2 bytes of X-OBCI default data.
(default = )
X-IsupMtype-IAM IAM default values.
CallingPartycategory Allow 2 bytes of
CallingParty category default data. (default = 0A)
X-FCI Allow 4 bytes of X-FCI default data. (default =
2001).
X-NOCI Allow 2 bytes of X-NOCI default data.
(default = 00).
7 108

CLI Reference Guide

Signaling
Profiles
TABLE 7 35 X-Header Profile Parameters (Continued)

Parameter
Length/
Range Description
X-HeaderExtensions
N/A
Use this object to enable/disable Receive and/or Send

headers associated with specified X-Headers. See Table 7
36 on page 7 110 for a list of X-Header parameters
associated with this object.
For each X-Header parameter, enable or disable the
associated RecvHeader and/or SendHeader flags:
RecvHeader By default, this flag is enabled to allow
reception of the specified X-Header on the ingress leg.
disabled
enabled (default)
SendHeader By default, this flag is enabled to honor
sending the specified X-Header on the egress leg.
disabled
enabled (default)
X-HeaderFlags
N/A
Collection of X-Header control flags which define specific

behaviors as indicated.
recvCfn Enable flag to interwork INFO messages with
CONFUSION message types to ISUP.
disabled (default)
enabled
recvResume Enable flag to interwork INFO messages
with RESUME message types to ISUP.
disabled (default)
enabled
recvSuspend Enable flag to interwork INFO messages
with SUSPEND message types to ISUP.
disabled (default)
enabled
sendCfn Enable flag to interwork ISUP messages
CONFUSION messages to the SIP side.
disabled (default)
enabled
sendResume Enable flag to interwork ISUP messages
RESUME messages to the SIP side.
disabled (default)
enabled
sendSuspend Enable flag to interwork ISUP messages
SUSPEND messages to the SIP side.
disabled (default)
enabled

7 109
CLI Reference Guide

Profiles
Signaling
TABLE 7 36 X-Header Parameter Table

X-Header
Description
X-ATP
Use to enable/disable X-ATP headers on incoming/outgoing directions separately.
X-AUT
Use to enable/disable X-AUT headers on incoming/outgoing directions separately.
X-BCI
Use to enable/disable X-BCI headers on incoming/outgoing directions separately.
X-CALLING-NUM
Use to enable/disable X-CALLING-NUM headers on incoming/outgoing directions

separately.
X-CHGDelay
Use to enable/disable X-CHGDelay headers on incoming/outgoing directions

separately.
X-CHGInfo
Use to enable/disable X-CHGInfo headers on incoming/outgoing directions

separately.
X-CONTRACT-ADDR
Use to enable/disable X-CONTRACT-ADDR headers on incoming/outgoing

directions separately.
X-Carrier-Info
Use to enable/disable X-Carrier-Info headers on incoming/outgoing directions

separately.
X-EMG
Use to enable/disable X-EMG header on incoming/outgoing directions separately.
X-FCI
Use to enable/disable X-FCI headers on incoming/outgoing directions separately.
X-FWDORIG-NUM
Use to enable/disable X-FWDORIG-NUM headers on incoming/outgoing

directions separately.
X-GENERIC-NUM
Use to enable/disable X-GENERIC-NUM headers on incoming/outgoing directions

separately.
X-ISUPEvent
Use to enable/disable X-ISUPEvent headers on incoming/outgoing directions

separately.
X-ISUPMtype
Use to enable/disable X-ISUPMtype headers on incoming/outgoing directions

separately.
X-NOCI
Use to enable/disable X-NOCI headers on incoming/outgoing directions

separately.
X-OBCI
Use to enable/disable X-OBCI headers on incoming/outgoing directions

separately.
X-ORIGCLD-NUM
Use to enable/disable X-ORIGCLD-NUM headers on incoming/outgoing directions

separately.
X-REDBWDINF
Use to enable/disable X-REDBWDINF headers on incoming/outgoing directions

separately.
X-REDCAP
Use to enable/disable X-REDCAP headers on incoming/outgoing directions

separately.
X-REDCNT
Use to enable/disable X-REDCNT headers on incoming/outgoing directions

separately.
X-REDFWDINF
Use to enable/disable X-REDFWDINF headers on incoming/outgoing directions

separately.
X-TMR
Use to enable/disable X-TMR headers on incoming/outgoing directions separately.
XUSI
ConfigurableinXHeaderProfiletoenableordisabletheXUSIheaderson
incoming/outgoingdirectionsseparately.
7 110

CLI Reference Guide

Signaling
Profiles
IP Signaling Profile
This object allows you to configure the following signaling profiles:
"H.323 Profile" on page 7 111

"SIP Profile" on page 7 118
Following sub sections provides command syntax and parameter descriptions.
H.323 Profile
The H.323 Profile includes the following objects:
"commonIpattributes" on page 7 111

"egressIpAttributes" on page 7 114
"ingressIpAttributes" on page 7 116
"ipProtocolType" on page 7 117
commonIpattributes
This section lists CLI command syntax to configure common IP attributes for
communicating with the peer regardless of call direction.
Command Syntax
% set profiles signaling ipSignalingProfile DEFAULT_H323
commonIpAttributes
flags
addPChargingFuncAddr <disable|enable>
audioCodecChangeThroughEmptyTcs <disable|enable>
clearmodeForDataCalls <disable|enable>
disableConstrainedCapacities <disable|enable>
disableMediaLockDown <disable|enable>
includeG729WithG729aWhenOfferPspHasG729a
<disable|enable>
minimizeRelayingOfMediaChangesFromOtherCallLegAll
<disable|enable>
sendEmptyTcs <disable|enable>
sendRtcpPortInSdp <disable|enable>
terminalPortabilityInterworking <disable|enable>

7 111
CLI Reference Guide

Profiles
Signaling
Command Parameters
TABLE 7 37 IP Signaling Profile H.323 Common IP Attributes
Parameter
Length/
Range Description
addPChargingFuncAddr
N/A
Enable flag to transparently pass P-ChargingFunction-Address from ingress to egress message.

This feature applies to all INVITE in-dialog requests
and responses.
disable (default)
enable
audioCodecChangeThroughEmpty
Tcs
N/A
Enable flag to perform audio codec change (e.g. G.711

fax fallback) using empty Terminal Capability Set
(TCS). When disabled, SBC 5x00 performs audio
codec change using request mode.
disable (default)
enable
clearmodeForDataCalls
N/A
Set flag to enable the clearmode function for data calls

disable (default) If disabled for the SIP Egress
call leg, legacy operation is signaled and payload
type is assumed implicit (same on both sides). If
disabled for the SIP Ingress call leg, legacy G.711
operation is accepted as well as Clearmode.
enable If enabled for the SIP Egress call leg,
Clearmode is sent using dynamic payload type. If
enabled for SIP Ingress call leg, only Clearmode
data calls are accepted.
disableConstrainedCapacities
N/A
Set this flag to present a full TCS to its peer during call
setup or media modification. When disabled, SBC
5x00 presents only the selected codec in the TCS, and
follows up with a full TCS after media establishment.
disable (default)
enable
disableMediaLockDown
N/A
Enable this flag to allow SBC 5x00 to disable media

lock down by not sending SIP Re-INVITE/UPDATE
messages.
disable (default)
enable
includeG729WithG729aWhenOffe
rPspHasG729a
N/A
Controls whether the H.323 Service Group includes

G.729 along with G.729A in the network offer when the
SBC 5x00 offer Packet Service Profile has G.729A.
disable (default)
enable
7 112

CLI Reference Guide

Signaling
Profiles
TABLE 7 37 IP Signaling Profile H.323 Common IP Attributes (Continued)

Parameter
minimizeRelayingOfMediaChang
esFromOtherCallLegAll
Length/
Range Description
N/A
Enable flag to minimize relaying media changes to the

other call leg by not sending re-INVITE messages from
Server 1 to Server 2 in peer-to-peer pass-through
without transcoding scenarios. This shields the call leg
to Server 2 from the end-to-end propagation of SDP
offers and answers. The SBC 5x00 implements hold
and resume operations for the call leg from Server 1
internally and responds with answers without signaling
to the other call leg that media is being stopped or
restarted.
disable (default)
enable
NOTE: When enabled and a call is put on hold,
rogue media detection may occur and call may
get 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, and should only be used with the
understanding of the drawbacks described in
this note.
sendEmptyTcs
N/A
Set this flag to send an empty TCS to the peer to

restart the peers forward channel in a scenario where
there is an address update in the direct media case.
disable (default)
enable
sendRtcpPortInSdp
N/A
When enabled, SBC 5x00 adds the

attribute,a=rtcp:<rtcpPort> to the audio and video m
lines in the outgoing SDP (Rtcp port mentioned will be
SBC RTP port + 1).
disable (default)
enable
terminalPortabilityInterwork
ing
N/A
Enable flag to provide a service between ISUP and

SIP to move a terminal from one socket to another, or
to move a call from one terminal to another while the
call is active.
disable (default)
enable

7 113
CLI Reference Guide

Profiles
Signaling
Command Example
% show profiles signaling ipSignalingProfile DEFAULT_H323
ipProtocolType h323;
commonIpAttributes {
flags {
audioCodecChangeThroughEmptyTcs
disableConstrainedCapacities
includeG729WithG729aWhenOfferPspHasG729a
sendEmptyTcs
disable;
disable;
disable;
disable;
}
}
egressIpAttributes
This section lists CLI commands to configure H.323 egress IP attributes for
sending a call in the forward direction to the peer.
Command Syntax
egressIpAttributes
bci
bciInterworkEncountered <disable|enable>
bciIsdnAddress <disable|enable>
flags
delayCutThrough
dontSendFastStartProposal
insertInBandIndication
qosBasedRouting
waitTillConnectBeforeAbandonFastStart
mediaQosKpiProfile <profile name>
numberGlobalizationProfile <profile name>
signalingQosKpiProfile <profile name>
7 114

CLI Reference Guide

Signaling
Profiles
Command Parameters
TABLE 7 38 IP Signaling Profile H.323 Egress IP Attributes
Parameter
Length/
Range
Description
bci
N/A
Configures the bci flag.

bciInterworkEncountered Enable to set the
Interworking Indicator bit in the BCI parameter of
backward SS7 messages (e.g., ACM or ANM).
disable (default)
enable
bciIsdnAddress Enable to set the ISDN Access
Indicator bit in the BCI parameter of backward SS7
messages (e.g., ACM or ANM).
disable (default)
enable
flags
N/A
Egress IP attribute flags:

delayCutThrough Enable flag to use Delay Cut
Through feature.
disable (default)
enable
dontSendFastStartProposal Enable flag to
prevent sending a fast start proposal.
disable (default)
enable
insertInBandIndication When this flag is enabled,
on receipt of an H.225 ALERT message, the egress H.323
signaling gateway on the SBC 5x00 inserts in-band
indication in the ALERT message in backward direction.
disable (default)
enable
qosBasedRouting Enable flag to allow QoS-based
routing.
disable (default)
enable
waitTillConnectBeforeAbandonFastStart
Enable to allow SBC 5x00 to abandon FastStart
procedures if H.323 Connect message is received, a
FastConnectRefused message is received, or H.245
address is received (in accordance with the procedures
defined in H.323 V4 for switching to H.245).
disable (default)
enable
mediaQosKpiProfile
N/A
Specify the Media QoS KPI (Key Performance Indicator)

Profile name.
numberGlobalizationPro
file
N/A
Specify the Number Globalization Profile name. This object

is used to convert numbers to SIP global number format.

7 115
CLI Reference Guide

Profiles
Signaling
TABLE 7 38 IP Signaling Profile H.323 Egress IP Attributes (Continued)

Parameter
Length/
Range
N/A
Description
Specify the Signaling QoS KPI (Key Performance Indicator)
Profile name.
ingressIpAttributes
This section lists CLI commands to configure ingress IP attributes.
Command Syntax
ingressIpAttributes
flags
convertProgressToAlert <disable|enable>
dontSendFacilityMessage <disable|enable>
refuseFastStartProposal <disable|enable>
send183OnInitiatingDisconnectTreatment
<disable|enable>
sendFastStartResponseInCp <disable|enable>
Command Parameters
TABLE 7 39 IP Signaling Profile H.323 Ingress IP Attributes flags
Parameter
Length/
Range Description
convertProgressToAlert
N/A
Set this flag to convert Progress messages to Alert

messages when communicating to endpoints that have
difficulty with Progress messages.
disable (default)
enable
dontSendFacilityMessage
N/A
Set this flag to prevent sending Facility messages to

endpoints that do not tunnel and have difficulty processing
Facility messages.
disable (default)
enable
refuseFastStartProposal
N/A
When this flag is set, SBC 5x00 does not include FastStart
proposal in early media calls. Instead, it relies on H.245
procedure to complete media setup. When cleared, SBC
5x00 always includes fast start proposal in SETUP
message for early media calls.
disable (default)
enable
7 116

CLI Reference Guide

Signaling
Profiles
TABLE 7 39 IP Signaling Profile H.323 Ingress IP Attributes flags (Continued)

Length/
Range Description
Parameter
send183OnInitiatingDiscon
nectTreatment
N/A
Enable flag to send a 183 message on initiating a

disconnect treatment.
disable (default)
enable
sendFastStartResponseInCp
N/A
When this parameters is used, the SBC 5x00 sends a

FastStart response message in Call Proceeding
messages.
disable (default)
enable
ipProtocolType
This section lists CLI command syntax and parameter descriptions to configure IP
protocol type attributes.
Command Syntax
ipProtocolType <h323|sipI|sipOnly>
Command Parameters
TABLE 7 40 IP Signaling Profile H.323 IP Protocol Type
Parameter
Length/
Range
ipProtocolType
N/A
Description
Specifies the IP protocol type for the IP Signaling Profile. For
H.323 protocol, select h323.
h323
sipI
sipOnly (default)

7 117
CLI Reference Guide

Profiles
Signaling
SIP Profile
The SIP signaling profile uses the following objects:
"commonIpAttributes" on page 7 118

"egressIpAttributes" on page 7 141
"ingressIpAttributes" on page 7 153
"ipProtocolType" on page 7 157
commonIpAttributes
This section lists CLI commands to configure common IP attributes for
communicating with the peer regardless of call direction.
Command Syntax
% set profiles signaling ipSignalingProfile <profile_name>
commonIpAttributes
callTransferFlags
forceReRouteViaPsxQuery <disable|enable>
handleIpAddressesNotPresentInNetworkSelectorTableNst
<rejectCall|routeViaDefaultZoneIptg|
routeViaDefaultiptg|routeViaTransferringIptg>
flags
addPChargingFuncAddr <disable|enable>
addPathServiceRoute <disable|enable>
callHoldInterworking <disable|enable>
clearmodeForDataCalls <disable|enable>
createPChargingVector <disable|enable>
createPVisitedNetworkId <disable|enable>
createPathHeader <disable|enable>
createServiceRouteHeader <disable|enable>
customizedSessionTimerBehavior <disable|enable>
disableAlsoHeader <disable|enable>
disableHostTranslation <disable|enable>
disableMediaLockDown <disable|enable>
disableReferToUriParameters <disable|enable>
discardReceivedReasonHeader <disable|enable>
doNotIncludeSsAttributeInReInvite <disable|enable>
enableDefaultPUIProcedures <disable|enable>
enableDialStringHandling <disable|enable>
endToEndBye <disable|enable>
includeIpPortsInFromAndToHeaders <disable|enable>
7 118

CLI Reference Guide

Signaling
Profiles
includeReasonHeader <disable|enable>
includeSsAttributeInInitialInvite <disable|enable>
includeTransportTypeInContactHeader <disable|enable>
insertPeerAddressAsTopRouteHeader <disable|enable>
mapCauseLocation <disable|enable>
mapSuspendResumeEventInPSvcInfoHeader <disable|enable>
mapUuiInPSigInfoHeader <disable|enable>
mimeCausePrecedeReasonHeaderCause <disable|enable>
<disable|enable>
noContentDisposition <disable|enable>
noPortNumber5060 <disable|enable>
noUserinfoInContactHeader <disable|enable>
onlySelectedCodecInSessionRefresh <disable|enable>
pCalledPartyIDSupport <disable|enable>
pChgMsgInfo <disable|enable>
reQueryPsxOnRegisterRefresh <disable|enable>
rejectRefer <disable|enable>
replaceHostOnViaHeader <disable|enable>
restrictHistoryInfoHeader <disable|enable>
sdpOlineOnlyCompares <disable|enable>
sendAllAllowedCodecsForLateMediaInviteOrReInvite
<disable|enable>
sendDirectMediaInfoInSdpAttribute <disable|enable>
sendPtimeInSdp <disable|enable>
sendRtcpPortInSdp <disable|enable>
sessionTimerRefreshUpdate <disable|enable>
setAcceptHeaderToApplicationSdpOnly <disable|enable>
setOlineDash <disable|enable>
setSessionVersionZero <disable|enable>
setSlineDash <disable|enable>
skipPsxQueryForRefer <disable|enable>
storePChargingFuncAddr <disable|enable>
storePChargingVector <disable|enable>
storePathHeader <disable|enable>
storeServiceRouteHeader <disable|enable>
terminalPortabilityInterworking <disable|enable>
validateAccessNwInfoHeader <disable|enable>
optionTagInRequireHeader
7 119
CLI Reference Guide

Profiles
Signaling
suppressReplaceTag <disable|enable>
optionTagInSupportedHeader <optionTagInSupportedHeader>
suppressReplaceTag <disable|enable>
relayFlags
dialogEventPackage <disable|enable>
dtmfBody <disable|enable>
force503to500Relay <disable|enable>
info <disable|enable>
message <disable|enable>
notify <disable|enable>
options <disable|enable>
publish <disable|enable>
refer <disable|enable>
regEventPackage <disable|enable>
sonusMediaBody <disable|enable>
statusCode3xx <disable|enable>
statusCode4xx6xx <disable|enable>
thirdPartyBodies <disable|enable>
transparencyFlags
acceptContactHeader <disable|enable>
acceptHeader <disable|enable>
alertInformationHeader <disable|enable>
authcodeHeaders <disable|enable>
callInfoHeader <disable|enable>
contactHeader <disable|enable>
errorInfo <disable|enable>
fromHeader <disable|enable>
geolocation <disable|enable>
geolocationError <disable|enable>
geolocationRouting <disable|enable>
historyInfo <disable|enable>
maxForwardsHeader <disable|enable>
mwiBody <disable|enable>
pAccessNetworkInfoHeader <disable|enable>
pCalledPartyID <disable|enable>
pChargingVectorHeader <disable|enable>
pEarlyMedia <disable|enable>
pVisitedNetworkIDHeader <disable|enable>
7 120

CLI Reference Guide

Signaling
Profiles
passCompleteContactHeader <disable|enable>
pathHeader <disable|enable>
qsigBody <disable|enable>
reasonHeader <disable|enable>
referredByHeader <disable|enable>
requestURI <disable|enable>
routeHeader <disable|enable>
serviceRouteHeader <disable|enable>
sipBody <disable|enable>
sipfragBody <disable|enable>
toHeader <disable|enable>
toneBody <disable|enable>
unknownBody <disable|enable>
unknownHeader <disable|enable>
userToUserHeader <disable|enable>
viaHeader <disable|enable>

7 121
CLI Reference Guide

Profiles
Signaling
Command Parameters
TABLE 7 41 IP Signaling Profile SIP Common IP Attributes
Parameter
Length/
Range Description
callTransferFlags
N/A
Following call transfer flags are supported:

forceReRouteViaPsxQuery Enable this flag to allow SBC
5x00 to perform a PSX query for new routes instead of using the
IP address received in the Refer-To header.
disabled (default)
When this flag is disabled, the SBC 5x00 does one of following:
(1).
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.
(2). If IP address in Refer-To header does not match SBC 5x00
signaling IP address and it is present in SBC 5x00 Network

Selector table, the SBC 5x00 sends an INVITE message to
the IPTG selected from the Network Selector table.
(3). If IP address in the Refer-To header does not match SBC
5x00 signaling IP address and is not present in the SBC

5x00 Network Selector table, SBC 5x00 handles the
transfer via the Handle IP Addresses Not Present In
Network Selector Table NST field (see below).
enabled
handleIpAddressesNotPresentInNetworkSelectorTable
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 (default)
flags
N/A
The flags object includes the following parameters.

addPChargingFuncAddr Set (enable) this flag to add the
stored value of the PCFA header to a request or response.The
PCFA header value is stored based on the flag
storePChargingFuncAddr.
disable (default)
enable
addPathServiceRoute Enable this flag to allow SBC acting
as P-CSCF or IBCF to add two Path headers in REGISTER
request towards the Core (createPathHeader must be enabled)
OR allow SBC acting as IBCF to add two Service-Route headers
in 200 OK response for REGISTER towards the P-CSCF
(createServiceRouteHeader must be enabled).
disable (default)
enable
7 122

CLI Reference Guide

Signaling
Profiles
TABLE 7 41 IP Signaling Profile SIP Common IP Attributes (Continued)

Parameter
Length/
Range Description
flags (continued)
N/A
callHoldInterworking Set flag to enable Call Hold

Interworking service between ISUP and SIP. 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.
disable (default)
enable
clearmodeForDataCalls Set flag to enable the clearmode
function for data calls.
disable (default) If disabled for the SIP Egress call leg,
legacy operation is signaled and payload type is assumed
implicit (same on both sides). If disabled for the SIP Ingress
call leg, legacy G.711 operation is accepted as well as
Clearmode.
enable If enabled for the SIP Egress call leg, Clearmode is
sent using dynamic payload type. If enabled for SIP Ingress
call leg, only Clearmode data calls are accepted.
createPChargingVector Enable flag to create a new
PCharging-Vector header in outgoing message for INVITE and
REGISTER messages. The PCharging-Vector header is also
supported in SUBSCRIBE, OPTIONS, NOTIFY, MESSAGE,
PUBLISH and REFER messages when received from same
direction as REGISTER message.
The P-Charging-Vector header contains the ICID value, ICID
Generated at value and orig-ioi value. The string for orig-ioi value
can be configured at egress trunk group.
disable (default)
enable
createPVisitedNetworkId Enable flag to allow SBC acting
as P-CSCF to insert a P-Visited-Network-ID Header in the egress
REGISTER request with the P-Visited-Network-ID configured
string.
disable (default)
enable
createPathHeader Enable flag to create a new Path header
in the outgoing REGISTER request.
disable (default)
enable

7 123
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
7 124
createServiceRouteHeader Enable flag to create a new

Service-Route header in the outgoing 200 OK response for
REGISTER.
disable (default)
enable
customizedSessionTimerBehavior When enabled, the
remote peer expects customer-specific session timer behavior.
When disabled, the remote peer expects the standard session
timer behavior.
disable (default)
enable
disableAlsoHeader Enable this flag to allow SBC 5x00 to
ignore the Also header if received from the remote peer and 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.
disable (default)
enable
disableHostTranslation Use this flag to enable/disable
host name translation. 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.
disable (default)
enable
disableMediaLockDown Enable this flag to allow SBC 5x00
to disable media lock down by not sending SIP Re-INVITE/
UPDATE messages.
disable (default)
enable
disableReferToUriParameters By default, this flag is
disabled thereby allowing parameters in the SIP URI Refer-To
header to pass through to the outgoing INVITE URI. Enable this
flag to prevent the parameters from passing through.
disable (default)
enable
discardReceivedReasonHeader Enable flag to ignore
cause code in received Reason header. When disabled, the SBC
5x00 uses the cause code in the received Reason header.
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
flags (continued)
N/A
doNotIncludeSsAttributeInReInvite Enable flag to

prevent SBC 5x00 from sending 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.
disable (default)
enable
NOTE: a=silenceSupp:on is never sent to remote peer in
current implementation when silence suppression is on.
enableDefaultPUIProcedures Enable this flag to allow
default PUI procedures on egress trunk group. Note that the
Privacy Transparency flag must be disabled to allow this feature.
disable (default)
enable
enableDialStringHandling Enable flag to allow P-CSCF
to globalize and pass Request-Uri and its parameters
transparently when not manipulated by PSX and Request-Uri
transparency is not enabled.
disable (default)
enable
endToEndBye For SIP-to-SIP calls, enable flag to prevent
SBC 5x00 from issuing the 200 BYE on the side initiating the
disconnect until the 200 BYE is received from the other leg. When
disabled, 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.
disable (default)
enable
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.
disable (default)
enable
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.
disable (default)
enable

7 125
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
7 126
includeSsAttributeInInitialInvite Enable this flag to

send the a=silenceSupp:off 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.
disable (default)
enable
includeTransportTypeInContactHeader Enable flag to
allow the SBC 5x00 to include the Transport Type parameter in
the Contact headers of 3XX responses. When disabled, the SBC
5x00 does not include the Transport Type parameter.
disable (default)
enable
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 acts as a IMS BGCF proxy, and also supports
SIPconnect compliance for direct inward dialing.
disable (default)
enable
mapCauseLocation Enable this flag to add the cause
location is added to or retrieved from the SIP Reason header
when mapping ISUP-to-SIP or SIP-to-ISUP signaling (you must
also enable the Include Reason Header function). 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. When flag is
disabled, cause location mapping is off.
disable (default)
enable
mapSuspendResumeEventInPSvcInfoHeader Enable this
flag to map the suspend/resume event in the P-Svc-Info header.
When disabled, the SBC 5x00 does not map the suspend/resume
event in the P-Svc-Info header.
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
flags (continued)
N/A
mapUuiInPSigInfoHeader Specifies whether the SBC 5x00

maps the UUI parameter and includes it in the SIP P-Sig-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.
disable (default)
enable
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.
disable (default)
enable
Use flag to minimize relaying media changes to the other call leg
on a Sonus SBC. When enabled, SBC 5x00 does not send reINVITE messages from SIP Server 1 to SIP Server 2 in peer-topeer pass-through without transcoding scenarios. This shields the
call leg to SIP Server 2 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.
disable (default)
enable
NOTE: When this flag is enabled and a call is put on hold,
rogue media detection may occur and call may get 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, and
should only be used with the understanding of the
drawbacks described in this note.
noContentDisposition 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, remote peer expects the standard SIP message
format which includes Content Disposition header.
disable (default)
enable
noPortNumber5060 Use this parameter to control whether
port number 5060 is sent to the remote peer in the Request-URI
of PRACK, ACK, and BYE messages.

7 127
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
When enabled, the outgoing SIP URI does not include port
number 5060 (sip:user@host). In addition, 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 receive a port number in Record-Route
headers, the SBC 5x00 does not send out a port number in the
Record-Route and Route headers.
When disabled, the outgoing SIP URI includes port number 5060
(sip:user@host:5060). In addition, if SBC 5x00 does not receive a
port number in Record-Route headers of SIP request and
response messages, the SBC 5x00 inserts port number 5060 into
the outgoing Record-Route and Route headers.
disable (default)
enable
NOTE: Enable this flag to allow DNS NAPTR/SRV lookups.
noUserinfoInContactHeader When this flag is 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.
disable (default)
enable
onlySelectedCodecInSessionRefresh When flag is
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 re-INVITE message will be
identical to that in the last offer.
disable (default)
enable
pCalledPartyIDSupport Enable flag to allow SBC acting as
P-CSCF to store pCalledPartyID header when a call destined to
UE is received from IMS core network.
SBC inserts P-Asserted-Identity header in the 18x/2xx responses
received from UE towards core and places the stored P-CalledParty-ID information in the PAI header.
disable (default)
enable
pChgMsgInfo When enabled, the SBC 5x00 adds a PChgMsg 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.
disable (default)
enable
7 128

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
flags (continued)
N/A
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 requery the SBC 5x00 on a register refresh. This setting must be
made on the ingress trunk group profile facing the registered
endpoint.
disable (default)
enable
rejectRefer When enabled, the SBC 5x00 rejects SIP
REFER messages from the peer and responds with a 405
Method Not Allowed message.
disable (default)
enable
relayDataPathModeChangeFromOtherCallLeg Enable
flag to relay data path mode changes from other call leg.
disable (default)
enable
NOTE: This flag is only accessible when the flag
(page page 7 127) is set to enable.
replaceHostOnViaHeader Use flag to replace 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.
disable (default) SBC 5x00 defaults to B2BUA behavior
where the VIA header contains local SIP signaling address.
enable Replaces 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.
restrictHistoryInfoHeader Enable this flag to restrict
History InfoHeader Flag depending upon the Privacy header or
Privacy URI.
disable (default)
enable
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.
disable (default)
enable

7 129
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
sendAllAllowedCodecsForLateMediaInviteOrReInvite
Enable this flag to allow SBC 5x00 to send 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.
disable (default)
enable
sendDirectMediaInfoInSdpAttribute -Enable flag to send
direct media information in the SDP attribute X-DMI.
disable (default)
enable
NOTE: The directMediaAllowed flag must be disabled on
the associated trunk group.
sendPtimeInSdp When enabled, the SBC 5x00 sends
a=ptime in the SDP.
disable (default)
enable
sendRtcpPortInSdp When enabled, SBC 5x00 adds the
attribute,a=rtcp:<rtcpPort> to the audio and video m lines in the
outgoing SDP (Rtcp port mentioned will be SBC RTP port + 1).
disable (default)
enable
sessionTimerRefreshUpdate Enable flag to control
session timer refresh method with SIP peers via UPDATE
messages. When disabled, the SBC 5x00 sends INVITE
messages.
disable (default)
enable
setAcceptHeaderToApplicationSdpOnly Use flag to
specify the Accept header format in SIP messages expected by
the remote peer. When enabled, the remote peer receives a short
Accept header format containing the application/SDP value only.
When disabled, the remote peer receives the standard Accept
header format containing all of the standard parameters.
disable (default)
enable
setOlineDash Specifies the SDP O-Line format in the SDP of
SIP messages expected by the remote peer. When enabled, the
remote peer receives an O-Line format in which the username
component is set to a - (dash). When disabled, the remote peer
receives the standard O-Line format containing all of the O-Line
parameters, including the username.
disable (default)
enable
7 130

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
flags (continued)
N/A
setSessionVersionZero Enable flag to set the session

version to zero in the o-line of the outbound SDP. When disabled,
the SBC 5x00 assigns a session version randomly.
disable (default)
enable
setSlineDash Specifies the SDP S-Line format in the SDP of
SIP messages expected by the remote peer.
disable (default) Remote peer receives standard S-Line
format containing all of the S-Line parameters.
enable Remote peer receives a short S-Line format
containing a dash only (s=-).
skipPsxQueryForRefer Set flag to skip the ERE query for
Refer flag.
disable (default)
enable
storePChargingFuncAddr Set this flag to store the values
received in the PCFA header in a request or response. The stored
value is added to a subsequent response or a request based on
the flag addPChargingFuncAddr.
disable (default)
enable
storePChargingVector When this flag is enabled, the SBC
5x00 stores the P-Charging-Vector (PCV) received in requests.
When the response is forwarded back, the stored PCV is inserted
and sent. Below is an example of SBC 5x00 acting as IBCF:
INVITE (PCV1) --> SBC 5x00 --> INVITE
200 OK (PCV1) <-- SBC 5x00 <-- 200 OK
disable
enable (default)
storePathHeader Set this flag to locally store (cache) a Path
header received in an incoming REGISTER request.
disable (default)
enable
storeServiceRouteHeader Set this flag to locally store
(cache) a Service-Route header received in an incoming 200 OK
response to REGISTER.
disable (default)
enable
terminalPortabilityInterworking Enable flag to
provide a service between ISUP and SIP to move a terminal from
one socket to another, or to move a call from one terminal to
another while the call is active.
disable (default)
enable

7 131
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
validateAccessNwInfoHeader Enable flag to prevent

forwarding P-Access-Network-Info header when networkprovided parameter is present.
This flag is associated with Egress TG with respect to Request
and Response message (Core Side).
Note: This is applicable for both INVITE and non-INVITE
message and their responses.
optionTagInRequire N/A
Header
disable (default)
enable
Use this control to suppress REPLACE tag 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 ERE
query. This enables one SBC 5x00 to transfer two independent calls
and connect them together using IP trunk group (IPTG) routing.
IPTG routing must be enabled for this feature.
suppressReplaceTag 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.
disable (default)
enable
optionTagInSupport N/A
edHeader
Use this control to suppress the REPLACE tag 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 ERE 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.
suppressReplaceTag 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.
disable (default)
enable
7 132

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
relayFlags
N/A
Use this object to configure the following relay flags.

dialogEventPackage Enable this flag to allow SBC 5x00 to
send the Dialog Event Package to the peer.
disable (default)
enable
NOTE: This flag only applies to unregistered users.
dtmfBody Enable flag to allow SBC 5x00 to relay DTMF body
to the peer for responses to INVITE and BYE messages, relayed
INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request
messages, and relayed 3xx, 4xx, 5xx, and 6xx in response to
INVITE messages. Provision this flag on the ingress leg with
respect to the message direction.
disable (default)
enable
force503to500Relay Enable flag to force 503 Service
Unavailable message to map to 500 Internal Server Error
message.
disable (default)
enable
info Enable to relay SIP INFO method to the peer. If disabled,
the SBC 5x00 processes SIP INFO methods locally.
disable (default)
enable
message Enable to relay SIP MESSAGE method to the peer. If
disabled, the SBC 5x00 processes SIP MESSAGE methods
locally.
disable (default)
enable
notify Enable this flag to relay SIP NOTIFY method to the
peer. If disabled, the SBC 5x00 processes SIP NOTIFY methods
locally.
disable (default)
enable
options Enable this flag to relay SIP OPTIONS method to the
peer. If disabled, the SBC 5x00 processes SIP OPTIONS
methods locally.
disable (default)
enable

7 133
CLI Reference Guide

Profiles
Signaling

Parameter
relayFlags
(continued)
Length/
Range Description
N/A
publish Controls the transfer of instant messages (IMs).

Enable flag to allow SBC 5x00 to relay SIP PUBLISH methods to
the peer. When disabled, the SBC 5x00 processes SIP PUBLISH
methods locally. Provision this flag on the ingress leg with respect
to the message direction.
disable (default)
enable
refer When enabled, the SBC 5x00 relays SIP REFER
methods to the peer. When disabled, the SBC 5x00 processes
SIP REFER methods locally.
disable (default)
enable
regEventPackage Enable this flag to relay Registration Event
Package information to the peer. If disabled, the SBC 5x00 rejects
the Registration Event Package.
disable (default)
enable
sonusMediaBody Enable this flag to relay Sonus media body
to the peer for responses to INVITE and BYE messages, relayed
INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request
messages and relayed 3xx, 4xx, 5xx, and 6xx in response to
INVITE messages.
Provision this flag on the ingress leg with respect to the message
direction.
disable (default)
enable
statusCode3xx Enable this flag to relay 3xx status code to
the peer in response to INVITE requests.
Provision this flag on the trunk group that receives the 3xx
response (the egress leg of the call).
disable (default)
enable
statusCode4xx6xx Enable this flag to relay the error status
codes (4xx, 5xx, or 6xx) in response to initial INVITE requests
(does not apply to re-INVITEs).
NOTE: You must enable this flag when using
authcodeHeaders transparency flag.
Provision this flag on the trunk group that receives the error
response (the egress leg of the call).
disable (default)
enable
7 134

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
relayFlags
(continued)
N/A
thirdPartyBodies Enable this flag to relay third party bodies

to the peer in response to INVITE and BYE messages, relayed
INFO, REFER, MESSAGE, NOTIFY, OPTIONS, SUBSCRIBE
request methods and relayed 3xx, 4xx, 5xx, and 6xx responses to
INVITE methods.
Provision this flag on the ingress leg with respect to the message
direction.
disable (default)
enable
transparencyFlags
N/A
acceptContactHeader Set flag to allow P-CSCF to

transparently pass the received Accept-Contact Header.
disable (default)
enable
acceptHeader Use this flag to determine Accept header
behavior.
disable (default) Accept header includes: application/sdp,
application/isup, application/dtmf, application/dtmf-relay,
multipart/mixed information.
enable Accept header is transparently passed from ingress
to egress.
alertInformationHeader Set this flag to transparently copy
the ALERT INFO header from the ingress SIP INVITE method to
the egress SIP INVITE message.
disable (default)
enable
authcodeHeaders Enable this flag to transparently copy the
WWW Authentication header for SIP 401/407 response
messages or SIP Authorization/Proxy Authorization headers.
NOTE: You must enable statusCode4xx6xx relay flag when
using authcodeHeaders transparency.
disable (default)
enable
callInfoHeader Set flag to transparently pass Call-Info
header, if present, in the incoming message.
disable (default)
enable
contactHeader Set flag to transparently pass the Contact
Header Flag in egress leg with respect to the message direction.
disable (default)
enable
errorInfo Enable this flag to transparently copy the Error-Info
header from the ingress leg to the egress leg.
disable (default)
enable

7 135
CLI Reference Guide

Profiles
Signaling

Parameter
transparencyFlags
(continued)
Length/
Range Description
N/A
fromHeader Enable this flag to transparently copy the

userinfo@host component of the FROM header from the ingress
SIP INVITE message to the egress SIP INVITE message.
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.
disable (default)
enable
geolocation Set flag to transparently pass Geolocation
header, if present, in incoming message.
disable (default)
enable
geolocationError Set flag to transparently pass
Geolocation-Error header, if present, in incoming message.
disable (default)
enable
geolocationRouting Set flag to transparently pass
Geolocation-Routing header, if present, in incoming message.
disable (default)
enable
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.
This flag needs to be provisioned on the egress leg with respect
to the message direction.
disable (default)
enable
maxForwardsHeader Enable flag to transparently copy the
Max-Forwards header from the incoming message to the
outgoing message for INVITE, REGISTER, BYE, INFO,
OPTIONS, NOTIFY, REFER, and SUBSCRIBE.
disable (default)
enable
7 136

CLI Reference Guide

Signaling
Profiles

Parameter
transparencyFlags
(continued)
Length/
Range Description
N/A
mwiBody Enable flag to transparently copy the MWI body from

the incoming message to the outgoing message for INVITE,
REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and
SUBSCRIBE.
Provision this flag on the egress leg with respect to message
direction.
disable (default)
enable
pAccessNetworkInfoHeader Enable flag to transparently
pass the p-Access-Network-Info (PANI) header from ingress to
egress.
disable (default) SBC suppresses the PANI header towards
egress messages when the incoming message contains PANI
header.
enable SBC transparently passes PANI header from ingress
to egress.
NOTE: Enable this flag when SBC 5x00 is configured as PCSCF node.
pCalledPartyID Set flag to transparently pass the P-CalledParty-ID header from ingress to egress call leg.
disable (default)
enable
pChargingVectorHeader When enabled, the SBC 5x00
transparently copies the P-Charging-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, MESSAGE, PUBLISH, NOTIFY, REFER, and INFO
messages.
disable (default)
enable
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 egress leg with respect to message
direction.
disable (default)
enable

7 137
CLI Reference Guide

Profiles
Signaling

Parameter
transparencyFlags
(continued)
7 138
Length/
Range Description
N/A
pVisitedNetworkIDHeader Enable flag to pass the PVisited-Network-ID header transparently to the egress leg.
disable (default)
enable
passCompleteContactHeader Enable flag to copy the
Contact header parameters from the ingress message and insert
into the egress message when IPv6-IPv4 interworking exists
between UE and core.
disable (default)
enable
pathHeader Enable flag to transparently copy the Path header
from the ingress SIP message to the egress SIP message.
disable (default)
enable
qsigBody Enable flag to transparently copy the QSIG body
from the incoming message to the outgoing message for INVITE,
SUBSCRIBE.
Provision this flag on the egress leg with respect to message
direction.
disable (default)
enable
reasonHeader When enabled, the ingress Reason header
value is passed through unchanged.
disable (default)
enable
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.
Provision this flag on the egress leg (with respect to the message
direction).
disable (default)
enable
requestURI Enable flag to transparently copy the Request
URI from the incoming message to the outgoing message for
INVITE, REGISTER, SUBSCRIBE/NOTIFY.
Provision this flag on the egress leg (with respect to the message
direction).
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
transparencyFlags
(continued)
Length/
Range Description
N/A
routeHeader Enable flag to transparently copy the Route

header from the ingress SIP message to the egress SIP
message.
disable (default)
enable
serviceRouteHeader Enable flag to transparently copy the
Service-Route header from the ingress SIP message to the
egress SIP message.
disable (default)
enable
sipBody Enable flag to transparently copy the SIP body from
the incoming message to the outgoing message for INVITE,
SUBSCRIBE, if relayed.
Provision this flag on the egress leg with respect to the message
direction.
disable (default)
enable
sipfragBody Enable flag to transparently copy the SIPFRAG
body from the incoming message to the outgoing message for
INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER,
and SUBSCRIBE.
Provision flag on the egress leg with respect to the message
direction.
disable (default)
enable
toHeader Enable flag to transparently copy the
userinfo@host component of the TO header from the ingress
SIP INVITE message to the egress SIP INVITE message. When
flag is disabled, SBC 5x00 generates its own TO header.
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.
disable (default)
enable
toneBody Enable flag to transparently copy the Tone body
from the incoming message to the outgoing message for INVITE,
SUBSCRIBE.
direction.
disable (default)
enable

7 139
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
transparencyFlags
(continued)
N/A
unknownBody Enable flag to transparently copy the Unknown

body from the incoming message to the outgoing message for
INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER,
and SUBSCRIBE.
direction.
disable (default)
enable
unknownHeader Enable flag to transparently copy the
Unknown header from the incoming message to the outgoing
message for INVITE, REGISTER, BYE, INFO, OPTIONS,
NOTIFY, REFER, and SUBSCRIBE.
direction.
disable (default)
enable
userToUserHeader When the ingress INVITE contains the
User-to-User header and this transparency flag is enabled, the
User-to-User header passes through to the egress.
disable (default)
enable
viaHeader Use this flag to specify the behavior of VIA header,
the source address of the call originator.
disable (default) Default behavior where IP address on the
VIA header is the local SIP signaling address.
enable Transparently pass 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.
displaylevel
1-64
Command Example
From system-level prompt, use following command to view IP signaling profile
flags for DEFAULT_SIP profile in table format.
> show table profiles signaling ipSignalingProfile
DEFAULT_SIP egressIpAttributes flags
bgcfTargetSchemeTransparency
disable;
convertInactiveToSendrecv
disable;
disable2806Compliance
disable;
disableOptionalRegisterParameters
disable;
map181Or182MessageTo183
disable;
mapContractorNumberInPSigInfoHeader disable;
7 140

CLI Reference Guide

Signaling
Profiles
suppressUnregister
disable;
ttcIsupMapping
disable;
useCalledPartyInRequestUri
disable;
useColonInSdpMediaTypeParameter
disable;
validateIsubAddress
disable;
qosBasedRouting
disable;
egressIpAttributes
This section lists CLI commands to configure SIP egress IP attributes for sending
a call in the forward direction to the peer.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile
name> egressIpAttributes
bci
bciInterworkEncountered <disable|enable>
bciIsdnAddress <disable|enable>
domainName
useSipDomainNameInFromField <disable|enable>
preserveIngressFromDomainName <disable|enable>
useLowerCaseDomainNames <disable|enable>
useSipDomainNameInRequestUri <disable|enable>
preserveIngressRUriDomainName <disable|enable>
useLowerCaseDomainNames <disable|enable>
flags
bgcfTargetSchemeTransparency <disable|enable>
convertInactiveToSendrecv <disable|enable>
disable2806Compliance <disable|enable>
disableOptionalRegisterParameters <disable|enable>
map181Or182MessageTo183 <disable|enable>
mapContractorNumberInPSigInfoHeader <disable|enable>
qosBasedRouting <disable|enable>
suppressUnregister <disable|enable>
ttcIsupMapping <disable|enable>
useCalledPartyInRequestUri <disable|enable>
useColonInSdpMediaTypeParameter <disable|enable>
validateIsubAddress <disable|enable>
isub
allowNsapIsub <disable|enable>

7 141
CLI Reference Guide

Profiles
Signaling
allowUserSpecifiedIsub <disable|enable>
includeCalledPartyIsub <disable|enable>
includeCallingPartyIsub <disable|enable>
mediaQosKpiProfile <profile_name>
numberGlobalizationProfile <profile_name>
numberPortabilityAttributes
disableRn <disable|enable>
npdiOptions <doNotIncludeNpdi|includeNpdi|
includeNpdiYes>
privacy
flags
includeEmbeddedPAIheaderInRedirectedInvite
<disable|enable>
includePrivacy <disable|enable>
msLyncPrivacySupport <disable|enable>
privacyRequiredByProxy <disable|enable>
privacyInformation
<pAssertedId|pPreferredId|remotePartyId>
transparency <disable|enable>
redirect
contactHandling
<mergeReceivedContacts|purgeExistingContacts>
flags
forceRequeryForRedirection <disable|enable>
skipCrankbackProfileAndAlwaysCrankback
<disable|enable>
mode <acceptRedirection|allowSingleRedirectAttempt|
rejectRedirection>
signalingQosKpiProfile <profile_name>
sipHeadersAndParameters
callForwarding
dataMapping <diversion|purgeExistingContacts>
diversionHeaderTransparency <disable|enable>
destinationTrunkGroupOptions
flags
includeCic <disable|enable>
includeCpcInformation <disable|enable>
includeNpi <disable|enable>
includeOlip <disable|enable>
includePKAdn <disable|enable>
7 142

CLI Reference Guide

Signaling
Profiles
includePstnParameters <disable|enable>
includeQvalue <disable|enable>
skipCSeqCheckInEarlyDialog <disable|enable>
transparencyForDestinationTrunkGroupParameter
<disable|enable>
includeChargeInformation
<includeNone|includePChargeInfo>
originatingTrunkGroupOptions
<includeNone|includeOtg|includeTgrpWithDomainName|
includeTgrpWithIpAddress>
transport
type1...type4 <none|sctp|tcp|tlsOverTcp|udp>
Command Parameters
TABLE 7 42 IP Signaling Profile SIP Egress IP Attributes
Parameter
Length/
Range Description
bci
N/A
Use this object to configure Backward Call Indicator (BCI) for

Egress IP attributes.
bciInterworkEncountered Enable flag to indicate that
ISUP is interworking with a network which is not capable of
providing as many services as ISUP does. ISUP networks will
therefore not employ certain features they otherwise normally
would, including potentially the use of ISDN cause codes in
failure conditions .
disable (default)
enable
bciIsdnAddress Enable flag to enable ISDN Address in the
BCI parameter of backward SS7 messages (e.g. ACM or ANM).
disable (default)
enable

7 143
CLI Reference Guide

Profiles
Signaling
TABLE 7 42 IP Signaling Profile SIP Egress IP Attributes (Continued)

Parameter
Length/
Range Description
domainName
N/A
Use this object to specify use of domain names.

useSipDomainNameInFromField By default, SBC 5x00
uses its IP address as the host-port of the FROM URI in the
outgoing INVITE message. Enable flag to use the originating
gateway information returned in the policy response as the hostport of the FROM URI in the outgoing INVITE message.
disable (default)
enable (additional flags below)
preserveIngressFromDomainName If a SIP domain
is configured for the ingress trunk group and this flag is
enabled, 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.
- disable (default)
- enable
useLowerCaseDomainNames Set flag to allow lower
case domain name.
- disable (default)
- enable
useSipDomainNameInRequestUri Use SIP Domain Name
In Request URI Flag.
disable SBC 5x00 includes the IP address in the hostport portion of the Request-URI in outgoing SIP INVITE
messages.
enable SBC 5x00 includes the trunk group domain
associated with egress trunk group as destination domain
name in outgoing SIP INVITE messages.
preserveIngressRUriDomainName Preserve
Ingress R-URI Domain Name Flag. When enabled, the
ERE/SBC 5x00 uses domain name received in the
Request-URI as destination domain name in outgoing SIP
INVITE messages. Normally, outgoing SIP INVITE
messages contain the trunk group domain assigned to
egress trunk group.
- disable (default)
- enable
useLowerCaseDomainNames Set flag to allow lower
case domain name.
- disable (default)
- enable
7 144

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
flags
N/A
Use this object to set egress IP attribute flags.

bgcfTargetSchemeTransparency Enable flag to preserve
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.
disable (default)
enable
convertInactiveToSendrecv Enable flag to control the aline in the SDP of an egress SIP INVITE message by converting
a=inactive to a=sendrecv. When disabled, the SBC 5x00
continues to use a=inactive, when appropriate, in the egress
INVITE message.
disable (default)
enable
disable2806Compliance If enabled, the 2806 Compliance
Code is disabled and no phone context or user=phone
parameters are signaled in egress messages.
disable (default)
enable
disableOptionalRegisterParameters Enable flag to
prevent SBC 5x00 from sending the DTG (Destination Trunk
Group) parameter in the Contact header of egress REGISTER
messages.
disable (default)
enable
map181Or182MessageTo183 Enable flag to allow SBC 5x00
to map 181 or 182 response messages to 183. When disabled,
the SBC 5x00 handles 1xx response messages normally.
disable (default)
enable
mapContractorNumberInPSigInfoHeader Enable flag to
map the Contractor Number parameter into the outgoing SIP PSig-Info header. The P-Sig-Info header is a customer-specific
SIP header used to convey ISUP information in SIP messages.
disable (default)
enable
qosBasedRouting Enable flag to allow QoS-based routing.
disable (default)
enable

7 145
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
flags (continued)
N/A
7 146
suppressUnregister Enable flag to prevent SBC 5x00

from sending an unregister message (Register=0) to the
registrar upon expiration of a SIP UA registration. When
disabled, the SBC 5x00 generates unregister messages on the
egress leg if the UA does not refresh the registration on time.
disable (default)
enable
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.
disable (default)
enable
useCalledPartyInRequestUri When enabled, the SBC
5x00 copies the username 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 when interoperating with IPPBXs that require the real end station number in the Request
URI in order to do proper routing of calls terminating on them.
disable (default)
enable
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.
disable (default)
enable
validateIsubAddress When enabled, the SBC 5x00
validates ISUB digits for called and calling parties. When
disabled, the SBC 5x00 will not validate ISUB digits.

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
isub
N/A
Use this object to configure ISDN Calling Party Subaddress (ISUB)

parameters:
allowNsapIsub Enable to allow NSAP ISUB parameter.

disable (default)
enable
allowUserSpecifiedIsub Allow user-specified ISUB.
disable (default)
enable
includeCalledPartyIsub Include called party ISUB.
disable (default)
enable
includeCallingPartyIsub Include calling party ISUB.
disable (default)
enable
mediaQosKpiProfile
N/A
The Media QoS KPI (Key Performance Indicator) Profile name.
numberGlobalization
Profile
N/A
The Number Globalize Profile name. This profile converts

numbers to SIP global number format.
numberPortabilityAt
tributes
N/A
privacy
N/A
Number portability attributes configuration.

disableRn Enable flag to prevent the SBC 5x00 and ERE
SIP proxy/redirector from sending the SIP rn parameter in the
egress INVITE message when an LNP translated number is
present. When the flag is disabled, the SBC 5x00 and ERE SIP
proxy/redirector send rn=NNNN in the userinfo portion of the
Request URI, where NNNN is the LNP translated number.
disable (default)
enable
npdiOptions Use the following options to specify whether
the SBC 5x00 and ERE SIP proxy/redirector send the SIP NPDI
parameter in the egress INVITE message when LNP translation
is performed by ERE call processing or the preceding switch.
doNotIncludeNpdi Do not send the NPDI parameter.
includeNpdi Send npdi in the userinfo portion of the
Request URI.
includeNpdiYes (default) Send npdi=yes in the
userinfo portion of the Request URI.
Specifies the privacy parameters.
flags
includeEmbeddedPaiHeaderInRedirectedInvite
Enable this flag to include the embedded PAI header in the
redirected Invite message.
disable (default)
enable

7 147
CLI Reference Guide

Profiles
Signaling

Parameter
privacy (continued)
7 148
Length/
Range Description
includePrivacy Use this flag to specify whether the
SBC 5x00 includes privacy information in outgoing SIP
INVITE messages.
enabled (default) The SBC 5x00 includes either a PPreferred- Identity header or a P-Asserted-Identity header
(provisioned in Privacy Information above) in outgoing SIP
INVITE messages. The SBC 5x00 will include a PAsserted-Identity header in outgoing SIP INVITE
messages. The SBC 5x00 will also insert an Anonymous
identifier in the SIP From field and the SBC 5x00 will
include a Privacy header that contains a Critical token.
disabled The SBC 5x00 does not include a PPreferred-Identity header or a P-Asserted-Identity header,
an Anonymous identifier in the SIP From field, or a Privacy
header that contains a Critical token in outgoing SIP
INVITE messages, and the SBC 5x00 will not include a PAsserted-Identity header or a Privacy header that contains
a Critical token in outgoing SIP INVITE messages.
msLyncPrivacySupport Backward compatibility for the
Caller Privacy feature. The Caller privacy feature only works
if this flag is enabled.
disable (default)
enable
privacyRequiredByProxy Enable flag to indicate that
privacy service is mandated for any calls to the SIP trunk
(proxy). In this case, the SBC 5x00 includes 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 is rejected. If disabled, the
SBC 5x00 does not include a Proxy-Require header with
privacy value. The proxy accepts the call even if it cannot
provide privacy service.
disable (default)
enable
privacyInformation Use this object to specify which of
the following headers the SBC 5x00 uses when sending privacy
information in outgoing SIP INVITE messages:
pAssertedId Used among trusted SIP entities (typically
intermediaries) to carry the identity of the caller as it was
verified by authentication.
pPreferredId Used by a User Agent (UA) to carry the
identity the caller wishes to be used, and sent to a trusted
proxy to be inserted in the P-Asserted-Identity field.

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
privacy (continued)
N/A
remotePartyId Used among trusted SIP entities

(typically intermediaries) to carry the identity of the caller as it
was verified by authentication. This header is specified in an
earlier RFC that continues to be supported.
transparency Enable flag to allow ingress Privacy
information to pass through unchanged.
disable (default)
enable
redirect
N/A
Specifies the redirect parameters.
contactHandling Select one of the following to control

processing of contacts received in SIP Redirects:
mergeReceivedContacts Contacts received in
Redirects are ordered by q-value and inserted at the head of
the list of untried contacts.
purgeExistingContacts Contacts received in
Redirects are ordered by q-value and replace untried
contacts.
flags
forceRequeryForRedirection (applies to Invite
requests only) Use flag to re-query ERE with contact
information received in a 3xx response for redirection-type
scenarios.
disable (default)
enable
skipCrankbackProfileAndAlwaysCrankback
Enable this flag to force any 4xx6xx SIP response code to
cause crankback so the next potential contact or route is
tried. If disabled, only the response codes specified in default
SBC 5x00 crankback profile cause the call to crank back.
disable (default)
enable
mode Use this object to control SIP redirection:
acceptRedirection (default) Multiple redirections are
allowed.
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.
signalingQosKpiProf
ile
N/A
The Signaling QoS KPI (Key Performance Indicator) Profile name.

7 149
CLI Reference Guide

Profiles
Signaling

Parameter
sipHeadersAndParame
ters
7 150
Length/
Range Description
N/A
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.
- disable (default)
- enable
destinationTrunkGroupOptions Use this parameter to
specify destination trunk group options.
includeDtg Include the destination trunk group
parameter in SIP headers sent over associated trunk group.
includeNone (default) Do not include any trunk group
information.
includeTgrpWithDomainName Include trunk group with
domain name.
includeTgrpWithIpAddress Include the destination
trunk group, and include the trunk context as domain name.
flags Use this object to configure the SIP Headers and
Parameters flags:
includeCic If enabled, the SBC 5x00 includes the Carrier
Identification Code in a cic= parameter in outgoing INVITE
messages.
disable (default)
enable
includeCpcInformation If enabled, the SBC 5x00
includes 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, pay phone,
prison, hotel or unknown.
disable (default)
enable
includeNpi If enabled, the SBC 5x00 includes the
Numbering Plan Indicator in a npi= parameter in outgoing
INVITE messages.
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
sipHeadersAndParame
ters (continued)
Length/
Range Description
N/A
includeOlip If enabled, the SBC 5x00 includes the

Originating Line Information Parameter in a oli= parameter in
outgoing INVITE messages.
disable (default)
enable
includePKAdn When enabled, the SBC 5x00 includes the
P-K-Adn header in egress SIP messages. When disabled,
the SBC 5x00 does not include the P-K-Adn header. The PK-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).
disable (default)
enable
includePstnParameters If enabled, the SBC 5x00
includes 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).
disable (default)
enable
includeQvalue If enabled, the ERE SIP proxy/redirector
includes the qvalue parameter (for example, q=0.9) in the
Contact header of outgoing 3xx messages.
disable (default)
enable
skipCSeqCheckInEarlyDialog When enabled, the
SBC 5x00 accepts 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.
disable (default)
enable
transparencyForDestinationTrunkGroupParameter
When enabled, if ERE receives both tgrp parameter and
trunk-context in an ingress INVITE Request-URI, ERE 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.
disable (default)
enable

7 151
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
sipHeadersAndParame
ters (continued)
N/A
includeChargeInformation Select the

includePChargeInfo option to map charge information in a
call setup message (i.e., the charge parameter of an IAM) to PCharge-Info header in an outgoing SIP INVITE message. If the
ERE returns billing information in a policy response, the 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.
includeNone (default)
includePChargeInfo
originatingTrunkGroupOptions Use this parameter to
specify originating trunk group options.
includeNone (default) Do not include any trunk group
information.
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
Use this object to set up to four transport parameter types:
7 152
type1
type2
type3
type4
Each transport type above can be set to any one of the following
transport protocols:
none (default)
sctp
tcp
tlsOverTcp
udp

CLI Reference Guide

Signaling
Profiles
ingressIpAttributes
This section lists CLI commands to configure ingress IP attributes.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile
name> ingressIpAttributes
carrierInformation
generateTerminatingCa <disable|enable>
generateTerminatingCic <disable|enable>
flags
mapCalledPartyCategoryInPSigInfoHeader
<disable|enable>
noSdpIn180Supported <disable|enable>
registrationExpiresinExpiresHeader <disable|enable>
send183OnInitiatingDisconnectTreatment
<disable|enable>
sendSdpIn200OkIf18xReliable <disable|enable>
sendSdpInSubsequent18x <disable|enable>
sip181Supported <disable|enable>
sip182Supported <disable|enable>
Command Parameters
TABLE 7 43 IP Signaling Profile SIP Ingress IP Attributes
Parameter
Length/
Range
Description
carrierInformation
N/A
Carrier information parameters.

generateTerminatingCa Use this flag 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.
disabled (default)
enabled
generateTerminatingCic Use this flag 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.
disabled (default)
enabled

7 153
CLI Reference Guide

Profiles
Signaling
TABLE 7 43 IP Signaling Profile SIP Ingress IP Attributes (Continued)

Parameter
Length/
Range
flags
N/A
7 154
Description
mapCalledPartyCategoryInPSigInfoHeader Enable
flag to map Called Party Category parameter to outgoing SIP PSig-Info header. The P-Sig-Info header is a customer-specific
SIP header used to convey ISUP information in SIP messages.
disabled (default)
enabled
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.
disabled (default)
enabled
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.
disabled (default)
enabled
send183OnInitiatingDisconnectTreatment Enable
flag to send a 183 message on initiating a disconnect treatment.
disabled (default)
enabled
sendSdpIn200OkIf18xReliable Enable flag to send SDP
in final 200 OK response messages when provisional 18x
responses are reliable.
disabled (default)
enabled
sendSdpInSubsequent18x Enable flag to send SDP in
subsequent 18x response messages. When disabled, the SBC
5x00 may not send SDP in subsequent 18x response
messages.
disabled (default)
enabled
sip181Supported Enable flag to allow SBC 5x00 to support
SIP 181 Call Is Being Forwarded messages in the backward
direction on the ingress trunk group.
disabled (default)
enabled
sip182Supported -Enable flag to allow the SBC 5x00 to
support SIP 182 Queued messages in the backward direction on
the ingress trunk group.
disabled (default)
enabled

CLI Reference Guide

Signaling
Profiles
Command Example: Configuring SIP Over TCP

To configure SIP over TCP:
1. Assign this IP signaling profile to SIP trunk group(s):

% set addressContext a1 zone EXTERNAL sipTrunkGroup
EXT_NET policy signaling ipSignalingProfile
SIP_IPSIGPROF
2. 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
for SIP calls.
preference2 This second choice of
for SIP calls.
preference3 This third choice of
for SIP calls.
preference4 This fourth choice of
for SIP calls.
transport protocol
transport protocol
transport protocol
transport protocol
3. Select TCP.
EXT_NETWORK signaling transportPreference preference1
tcp
Command Example: Configuring SIP Over TLS
Configure client and server profiles:
1. Generate server certificate and show status.

% set system security pki certificate server fileName
server.p12 passPhrase gsx9000 type local state enabled
> show status system security pki certificate
certificate server {
encoding pkcs12;
status success;
}
2. Generate client certificate and show status. Both client and server certificates
display.
% set system security pki certificate client fileName
clientCert.der type remote state enabled
> show status system security pki certificate
certificate client {
encoding der;
7 155
CLI Reference Guide

Profiles
Signaling
status success;
}
certificate server {
encoding pkcs12;
status success;
}
3. Assign the installed certificates to the TLS profile:

% set profiles security tlsProfile defaultTlsProfile
serverCertName server clientCertName client
% commit
4. Assign TLS to the SIP signaling ports:

% set addressContext a1 zone ZONE1 sipSigPort 1 mode
outOfService state disabled
% commit
% set addressContext a1 zone ZONE1 sipSigPort 1
tlsProfileName defaultTlsProfile
% commit
inService state enabled
% commit
outOfService state disabled
% commit
% set addressContext a1 zone ZONE2 sipSigPort 2
tlsProfileName defaultTlsProfile
% commit
inService state enabled
% commit
5. Associate IP Signaling Profiles with TLS over TCP:

% set profiles signaling ipSignalingProfile IPSP_1
% commit
egressIpAttributes transport type1 tlsOverTcp
% commit
% commit
egressIpAttributes transport type1 tlsOverTcp
% commit
7 156

CLI Reference Guide

Signaling
Profiles
6. Associate SIP Trunk Groups to IP Signaling Profiles:

% set addressContext a1 zone ZONE1 sipTrunkGroup SIP_TG1
policy signaling ipSignalingProfile IPSP_1
% commit
% set addressContext a1 zone ZONE2 sipTrunkGroup SIP_TG2
policy signaling ipSignalingProfile IPSP_2
% commit
ipProtocolType
This section lists CLI commands to configure IP protocol type attributes.
Command Syntax
ipProtocolType <ipProtocolType>
Command Parameters
TABLE 7 44 IP Signaling Profile SIP IP Protocol Type Parameters
Parameter
Length/
Range Description
ipProtocolType
N/A
Specifies the IP protocol type for the IP Signaling Profile.

For SIP protocol, select sipOnly.
h323
sipI
sipOnly (default)

7 157
CLI Reference Guide

Profiles
Signaling
ISUP Signaling Profile

This object creates a template for the ISUP signaling services used by the ISUP
service group manipulating 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 used under that protocol revision.
To see the list of available default signaling profiles, perform the following
command:
% show profiles signaling isupSignalingProfile <profile
name>
Create a custom signaling profile by copying a default profile and then modifying
your copy rather than 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 using the command set
profiles signaling isupSignalingProfile <profile_name>, and set
the baseProfile parameter to the appropriate default profile.
Command Syntax
% set profiles signaling isupSignalingProfile <profile name>
accessDelivery
accessTransInFar
accessTransport
accessTransportInFac
addInfoTransfer
adpNumber
ait
allianceScreenInd
allowCaForAnnouncements
allowCallsOnHwBlock
allowUnscreenedCin
alwaysAddCnId
alwaysAddOptionalPtr
announcementInd
ansi95Cfn
ansi95Cqm
ansi95Grs
apm
assumeOutgoingDeviceIncluded
7 158

CLI Reference Guide

Signaling
Profiles
atRel
awaitTwoGroupMsgs
backwardGvns
baseProfile
baseVersion
bbIam
bciInCpgWithCit
bciRel
bcm
bloAfterSetup
blueBookInRel
buildRdiForSipIwk
businessGroup
callDiversion
callDiversionTreatment
callHistory
callModMsgs
callOfferingTreatment
callReference
callReferenceFrj
callTransferNumber
callTransferReference
calledBsm
calledInNum
calledNoa8ForNp
calledTfm
callingBsm
callingOfm
carrierSelection
causeInCpg
causeInRlc
ccl
ccnr
ccss
cellularCpcs
cfn
chargeArea
7 159
CLI Reference Guide

Profiles
Signaling
chargeIndSetting
chargeMsgInSpeech
chargeNumber
checkIxcAgainstTlec
chgBetweenAcmAndAnm
chgMsgBeforeAcm
ci
circuitAssignmentMap
citTermExchangeLogic
collectCallReq
colpColrIgw
com
compatibility
con
conferenceTreatment
conferenceTreatmentInAnm
connectedNumber
connectedNumberInAcm
connectedNumberInCpg
connectionPointTrunkType
connectionReq
connectionReqInFaa
connectionReqInFar
connectionReqInIam
connectionReqInInf
continuity
correlationId
cpgBeforeAcm
cpnRel
cqmCqr
cqmForResync
cqmOnCardSwap
cugInterlockCode
cvtCvr
deleteIxcTcCode
diagnostics
dialedNumber
discardContractorNum
7 160

CLI Reference Guide

Signaling
Profiles
displayInfoInAcm
displayInfoInCon
displayInfoInCpg
displayInfoInIam
displayInformation
dmsFe
dontClearCdrFields
dontGenerateDiags
dontMapToHeaderToOcn
dontSendExm
dpc
dpcInformation
dropAPPinIAM
dropCauseInAcmWhenIwk
dropUsiFromNonIsup
drs
eMcid
earlyAcmChgNoInd
echoControl
echoControlInIam
eci
eciTrap
egressService
eit
emergencyCallInf
fac
facility
fallback
fciUserPartChosenCarrier
fciUserPartIwk
fciUserPartTrans
forceEchoCntrl
forceEchoCntrlNoUpdate
forwardCallProgress
forwardGvns
forwardNetworkSpecificInfo
forwardSuspend
forwardTransferMessage
7 161
CLI Reference Guide

Profiles
Signaling
freePhoneInd
generateJapanIcsParams
genericAddressRel
genericDigits
genericName
genericNotification
genericNotificationInFac
genericNotificationRepeatable
genericNumInAcm
genericNumInFac
genericNumInInf
genericNumber
genericNumberInCpg
genericNumberRepeatable
genericNumberRepeatableIam
genericOperation
genericReference
gi
gr317ScreeningInd
groupRedirectionCount
hardToReachInd
holdingInd
hopCountState
hopCountValue
hopCounter
iamGeneratedCarrierCodeInCdr
iepsCpc
incomingTrunkIdCode
informationInd
inrInAllStates
inrInf
invTnsRelease
iriOri
iriOriRcv
iriOriSent
isubTypeFromSip
ituCai24
itxTxa
7 162

CLI Reference Guide

Signaling
Profiles
iui
jti
jurisdiction
ldli
locationNumber
locationOfRel
locationOfRel34
locationOfRel42
lookAheadForBusy
loopPrevention
lpa
maRel
mapDmsFeParameter
maxCalledPartyDigits
maxCallingPartyDigits
mi
mlpp
msi
multiCarrierEnvironment
ncr
networkData
networkIdentity
networkIndicator
networkManagement
networkManagementInfo
networkSwitchNumber
networkTransport
nfci
nfciLblRciProc
nfciLnk
nft
nii
niri
noAcmObciForSipApn
noChgCountIfFlexChgRate
noInNumberUpdates
noIpEchoInd
noObciSipAcm
7 163
CLI Reference Guide

Profiles
Signaling
notificationInd
npfi
nrmSupport
nrop
nsa
nsf
obciAnm
olipCheck
olipCheckOnSend
olm
onlyCpgInBandBeforeAcm
onlyScreenCitGen
onlySendAcmFor181
operatorSelection
operatorServiceInfo
opr
optionalFci
originatingIscPointCode
otgnAnsi92
otherDigitStringSpecialDigitF
overrideInBand
pam
pciPassOnDefault
pcli
presentationNumber
preventAcmToCpgMapping
propagationDelay
propagationDelaySupport
qor
reaffirmBlockAfterReset
recommendationInCai
redirectingNumber
redirectionCap
redirectionInfoAcm
redirectionInfoIam
redirectionNumRestrictionInRel
redirectionNumber
7 164

CLI Reference Guide

Signaling
Profiles
redirectionNumberInAcm
redirectionNumberInAnm
redirectionNumberRestriction
relForDuplicateIam
relForEarlyAnm
releaseLinkTrunking
remoteMnpDip
remoteOperationInRel
remoteOperations
removeHlcIfNoLlc
revision
rlcAcknowledgeGrs
routeInformation
routingInfoInd
rr
russiaRng
saveIamCit
sccpProcedure
scfId
screenCitBeforeCdr
sdnIncrement
segmentation
sendBloOnHwBlock
sendRscForCallsOnHwBlock
sendTwoGroupMsgs
sendingEnbloc
serviceActivation
serviceActivationInRel
serviceCodeInd
sgmPci
signalOnlySipAlert
signalingPointCode
simpleEcBciInAllBkMsg
sliInIam
slovakChargeMessage
spc6
spcInIrs
specialDigits
7 165
CLI Reference Guide

Profiles
Signaling
specialProcessReq
storeChargeForIscTcTypeAndPayPhone
subscriberPriorityClass
subsequentAddressMessage
suppressCitForPreSubAcm
t7Transit
t11Active
t11EarlyAcm
tandemCallCounter
tandemLimitCounter
tci
tit
tmrPrime
transMedUsedInNrm
transactionReq
transferInfo
transitCfn
transitNetworkSelection
transitReceivedCit
transitUnrecognized
transmissionMediumUsed
truncateCdpn
trunkOfferingSupport
u2uServiceLevel
ucic
uidActionInd
uidCapabilityInd
uniqueTransitCit
upaUpt
updateAnmBci
updateInternalNetworkIndicatorInCalledPartyNumber
updateNumberIncompleteIndicatorInCallingPartyIndicator
upvExchangeRoles
usePsxChgIndForCpgInPresubCall
userServiceInformation
userTeleService
usiPrime
usr
7 166

CLI Reference Guide

Signaling
Profiles
uuIndAcm
uuIndCon
uuIndInFar
uuIndRel
uuInfo
uuInfoAcm
uuiInInf
uuiRestrictions
uuindAnm
uuindCpg
validateIsubFromSip
versionId
visitorMa
% show profiles signaling isupSignalingProfile <profile
name> <parameter>
% delete profiles signaling isupSignalingProfile <profile
name> <parameter>
Command Parameters
TABLE 7 45 ISUP Signaling Profile Parameters
Parameter
Length/
Range Description
isupSignalingProfile
1-23
The name of the ISUP profile. The following default ISUP profiles
are available:
accessDelivery
N/A
ansi00
ansi88
etsi121
etsi356
gr317
itu-t88
itu-t92+
ttc87
ttc93+
Specifies whether the access delivery information is supported

for the ISUP Signaling Profile.
unSupported (default)
supported

7 167
CLI Reference Guide

Profiles
Signaling
TABLE 7 45 ISUP Signaling Profile Parameters (Continued)

Parameter
Length/
Range Description
accessTransInFar
N/A
Specifies whether the access transport parameter is supported

in the FAR for the ISUP Signaling Profile:
supported
accessTransport
N/A

supported
accessTransportInFac
N/A

in the FAC for the ISUP Signaling Profile.
supported
addInfoTransfer
N/A
Use this flag to support decoding and transiting of additional

Info Transfer Parameters.
supported
adpNumber
N/A
Use this flag to support decoding and transiting ADP Number

Parameters.
supported
N/A
ait
Specifies whether the AIT is supported for the ISUP Signaling

profile.
supported
allianceScreenInd
N/A
Specifies whether the Alliance Screen Indicator parameter is

supported for the ISUP Signaling profile.
supported
allowCaForAnnouncements N/A
Specifies whether the allow charge area parameter for

announcements are supported for the ISUP Signaling profile.
supported
allowCallsOnHwBlock
N/A
Use this flag to allow calls on a hardware blocked circuit.

supported
allowUnscreenedCin
N/A
Use this flag to allow values 0 and 2 of the Screening

Indicator in the ISUP Signaling profile.
supported
7 168

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
alwaysAddCnId
N/A
Set flag to supported to include cause code of CNID

parameter in IAM when calling party number is restricted even
if there is no parameter data received from SIP. When set to
unsupported, CNID is only generated if received from SIP.
(Protocol: Japan)
supported
alwaysAddOptionalPtr
N/A
Set to supported to always add optional parameter pointer

should into ISUP messages even when no optional
parameters are defined:
supported
announcementInd
N/A
Specifies whether the announcement indicator parameter is

supported for the ISUP Signaling Profile.
supported
ansi95Cfn
N/A
Specifies whether the ANSI-95 format for Confusion (CFN)

which includes optional parameters should be used.
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.
supported
ansi95Grs
N/A
Specifies whether the ANSI-95 format for Group Reset Circuit

(GRS) which includes optional parameters should be used.
supported
N/A
apm
Specifies whether the APM is supported for the ISUP

Signaling profile.
supported
assumeOutgoingDeviceInc N/A
luded
Set flag to supported to allow egress echo cancellation

software to assume for an ISUP transit call that an outgoing
device is included regardless of the NCI setting.
supported
atRel
N/A
Specifies whether the AT is supported in the REL for the ISUP

Signaling profile:
supported

7 169
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
awaitTwoGroupMsgs
N/A
Set flag to supported to await two group messages in the

ISUP Signaling Profile.
supported
backwardGvns
N/A
Specifies whether the backward GVNS parameter is

supported for the ISUP Signaling Profile:
supported
baseProfile
N/A
Specifies the Base Signaling group profile name.
baseVersion
N/A
Specifies the Base Signaling group version from RFC3204.
bbIam
N/A
defaultRfc3204Ansi00
defaultRfc3204Ansi88
defaultRfc3204Etsi121
defaultRfc3204Etsi356
defaultRfc3204Gr317
defaultRfc3204ItuT88
defaultRfc3204ItuT92
defaultRfc3204Ttc87
defaultRfc3204Ttc93
ansi00
ansi88
etsi121 (default)
etsi356
gr317
itut88
itut92
none
ttc87
ttc93
Specifies whether the User-To-User indicator parameter is

supported in IAM for the ISUP Signaling Profile.
supported
bciInCpgWithCit
N/A
This control determines whether BCI parameter is included in

CPG message, and only applies when a CPG is generated
and no ACM/CPG message is received.
unSupported (default) BCI parameter is included in
CPG with or without CIT parameter.
supported BCI parameter is not in CPG unless it
contains CIT parameter.
7 170

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
bciRel
N/A
Specifies whether the BCI is supported in the REL for the

supported
N/A
bcm
Specifies if the Backwards Charging Message is supported for

the ISUP Signaling Profile.
supported
bloAfterSetup
N/A
Indicates to send a BLO message for some ANSI protocols

when blocking a circuit after a backwards message is received
during the call.
supported
blueBookInRel
N/A
Specifies whether the Blue Book parameters are supported in

REL for the ISUP Signaling Profile.
supported
buildRdiForSipIwk
N/A
When interworking with SIP and the IAM contains the original
called number and redirecting number parameters but no
redirecting information (RDI) parameter, the SBC 5x00
generates RDI with the following values:
redirecting indicator (3) call forwarded

redirecting counter (1)
original redirection reason (2) no reply
redirection reason (2) no reply
Flag options:
supported
businessGroup
N/A
Specifies if the Business Group parameter is supported for the

ISUP Signaling profile.
supported
callDiversion
N/A
Specifies if the call diversion is supported for the ISUP

Signaling profile.
supported
callDiversionTreatment
N/A
Specifies if the call diversion treatment parameter is supported

for the ISUP Signaling profile.
supported

7 171
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
callHistory
N/A
Specifies if the call history parameter is supported for the ISUP

Signaling profile.
supported
callModMsgs
N/A
Use flag to specify that the CMR, CMA and CMRJ are
supported
callOfferingTreatment
N/A
Indicates if the call offering treatment parameter is supported

supported
callReference
N/A
Indicates if the call reference parameter is supported for the

supported
callReferenceFrj
N/A
Indicates that the call reference parameter is supported in the

FRJ message.
supported
callTransferNumber
N/A
Indicates if the call transfer number parameter is supported for

the ISUP Signaling profile.
supported
callTransferReference
N/A
Indicates if the call transfer reference parameter is supported

supported
calledBsm
N/A
Indicates if the called Subs Basic Service Marks parameter is

supported
N/A
Indicates if the called directory number parameter is supported

supported
calledInNum
N/A
Indicates if the called IN number parameter supported for the

supported
7 172

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
calledNoa8ForNp
N/A
Indicates if Called Noa value 8 is supported. (Protocols: ITU,

China).
supported
calledTfm
N/A
Indicates if Called Subs Term Facility Marks parameter is

supported
callingBsm
N/A
Indicates if the Calling Subs Basic Service Marks parameter is

supported
callingOfm
N/A
Indicates if Calling Subs Orig Facility Marks parameter is

supported
carrierSelection
N/A
Indicates if carrier selection is supported for the ISUP

Signaling profile.
supported
causeInCpg
N/A
Indicates if the cause parameter supported in the CPG for the

supported
causeInRlc
N/A
Indicates if cause parameter is supported in the RLC for the

supported
ccl
N/A
Indicates if Calling Party Clearing (CCL) message is

supported.
supported
ccnr
N/A
Indicates if CCNR Possible Indicator parameter is supported

supported
ccss
N/A
Indicates if CCSS parameter supported for the ISUP Signaling

profile.
supported

7 173
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
cellularCpcs
N/A
Indicates if Calling Party Category values Cellular and Cellular

Roaming are recognized. (Protocols: ITU, China)
supported
N/A
cfn
Indicates if CFN is supported for the ISUP Signaling profile.

supported
chargeArea
N/A
Use this Service Control to populate the Charge Area with a

valid 5-digit Charge Area code. The Charge Area is set in the
ACM or CPG message if a script is returned from the ERE, or
for Disconnect treatment for SIP MIME case.
chargeIndSetting
N/A
Use this flag to set the BCI charge indicator to charge or no

charge, transit whatever is received, or simply to nothing at all
(in the case of ISDN where it defaults to 0).
chargeMsgInSpeech
N/A
charge
noCharge
noIndication
transit (default) Transit whatever is received from the
sending side (egress of network).
Indicates if the Charge Message In Speech parameter is

unsupported (default)
supported
chargeNumber
N/A
Indicates if the Charge Number parameter is supported for the

supported
checkIxcAgainstTlec
N/A
Set flag to supported to allow SBC 5x00 to compare the IXC

code configured on policy server with the TLEC carrier code
added by the terminating exchange. If they are the same, SBC
5x00 will not add in duplicate information.
Set flag to unsupported to allow SBC 5x00 to add in IXC data
with the same carrier code as the TLEC information. (Protocol:
Japan)
supported
chgBetweenAcmAndAnm
N/A
When set to supported, the SBC 5x00 sends the CHG

message in the backward direction between an ACM and
ANM. (Protocol: Japan)
supported
7 174

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
chgMsgBeforeAcm
N/A
When set to supported, the SBC 5x00 transits the CHG

message in the backward direction before ACM is received.
(Protocol: Japan)
supported
N/A
ci
Specifies if CI6 is supported in the ISUP Signaling profile.

supported
circuitAssignmentMap
N/A
Specifies if circuit assignment map parameter is supported for

supported
citTermExchangeLogic
N/A
Use this control to specify whether to include CIT/CAI

information in first or all backward (ACM/CPG) messages.
unsupported (default) CIT/CAI information is added to
all backward ACM/CPG messages supporting them.
supported Only the first backward message contains
CIT/CAI information.
collectCallReq
N/A
Specifies if the collect call request parameter is supported for

supported
colpColrIgw
N/A
Use this parameter to enable/disable support COLP-COLR

and IGW functionality. The supported protocols are ITU/ANSI.
COLP = Connected Line id Presentation
COLR = Connected Line id Restriction
IGW = ISUP Gateway
supported
N/A
com
Specifies if COM message is supported for the ISUP Signaling

profile.
supported
compatibility
N/A
Specifies if compatibility is supported for the ISUP Signaling

profile.
supported
con
N/A
Specifies if CON message is supported before an ACM is

transited.
unsupported
supported (default)

7 175
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
conferenceTreatment
N/A
Specifies if the conference treatment parameter is supported

supported
conferenceTreatmentInAn N/A
m
Specifies whether the Conference Treatment parameter in the

ANM is supported for the ISUP Signaling profile.
supported
connectedNumber
N/A
Specifies if the connected number is supported for the ISUP

signaling profile.
unsupported
supported (default)
connectedNumberInAcm
N/A
Specifies if the connected number parameter is supported in

the ACM for the ISUP Signaling profile.
supported
connectedNumberInCpg
N/A
Specifies if the connected number parameter is supported in

the CPG for the ISUP Signaling profile.
supported
connectionPointTrunkTyp N/A
e
Specifies if the Connection Point Trunk Type is supported for

supported
connectionReq
N/A
Specifies whether the Connection Request parameter is

supported
connectionReqInFaa
N/A
Specifies if connection request parameter is supported in the

FAA for the ISUP Signaling profile.
supported
connectionReqInFar
N/A

FAR for the ISUP Signaling profile.
supported
connectionReqInIam
N/A

IAM for the ISUP Signaling profile.
unsupported
supported (default)
7 176

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
connectionReqInInf
N/A
Specifies if connection request is supported in the INF for the

supported
continuity
N/A
Specifies if the Continuity procedures are supported for the

unsupported
supported (default)
correlationId
N/A
Specifies if correlation ID parameter supported for the ISUP

Signaling profile.
supported
cpgBeforeAcm
N/A
Specifies if CPG arriving before an ACM is transited.

supported
cpnRel
N/A
Specifies if the CPN is supported in the REL for the ISUP

Signaling profile.
supported
cqmCqr
N/A
Specifies if the CQM/CQR is supported for the ISUP Signaling

profile.
supported
cqmForResync
N/A
Specifies if a Cqm PDU is sent to resync when transitioning

from Mtp Pause to Resume state.
supported
cqmOnCardSwap
N/A
Specifies if CQM on Card Swap operation is supported in the

supported
cugInterlockCode
N/A
Indicates if the Closed User Group Interlock Code is supported

for the ISUP signaling profile.
unsupported
supported (default)
cvtCvr
N/A
Specifies if Circuit Validation Test/Response procedures are

supported
deleteIxcTcCode
N/A
Delete the IXC/TC code in the CIT for SIP MIME case. (up to 4
characters)

7 177
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
diagnostics
N/A
Indicates if Diagnostics field is supported for the ISUP

signaling profile.
unsupported
supported (default)
dialedNumber
N/A
Indicates if the Dialed Number parameter is supported for the

supported
discardContractorNum
N/A
When set to supported, the SBC 5x00 discards Contractor

number parameter in the IAM (SBB-specific) message.
(Protocol: Japan)
supported
displayInfoInAcm
N/A
Indicates if the Display Information parameter in the ACM is

supported
displayInfoInCon
N/A
Indicates if the Display Information parameter in the CON is

supported
displayInfoInCpg
N/A
Indicates if Display Information parameter in the CPG is

supported
displayInfoInIam
N/A
Indicates if the display Information parameter in the IAM is

supported
displayInformation
N/A
Indicates if the display information parameter is supported for

supported
dmsFe
N/A
Indicates if DMS FE field should be supported for the ISUP

Signaling profile.
supported
dontClearCdrFields
N/A
Set flag to supported to not clear Called Charge Area and/or

Charging Rate when Charge Information Delay parameter is
received in ACM or CPG. (Protocol: Japan)
supported
7 178

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
dontGenerateDiags
N/A
Set flag to supported to not generate diagnostics for JAPAN.

supported
dontMapToHeaderToOcn
N/A
Set flag to supported to not interwork the To header field to

ISUP original called number when interworking between SIP
and ISUP.
supported
dontSendExm
N/A
Set flag to supported to not send EXM messages on a trunk

group.
supported
N/A
dpc
If flag is set to supported, DPC parameters are decoded and

transited. (Protocol: Japan)
supported
dpcInformation
N/A
If set to supported, the SBC 5x00 generates/transits or

discards the DPC information parameter in the IAM. (Protocol:
Japan)
supported
dropAPPinIAM
N/A
Use this parameter to drop the APP with context ID = 0x3FFF

in IAM for ANSI.
supported
dropCauseInAcmWhenIwk
N/A
Specifies if the CAUSE parameter in ACM is suppressed when

announcement is played after interworking.
supported
dropUsiFromNonIsup
N/A
Specifies if the USI parameter is supported when the far-side

is not ISUP.
supported
N/A
drs
Specifies if DRS is supported in the ISUP Signaling Profile.

supported
eMcid
N/A
Specifies if MCID is supported for the ISUP Signaling Profile.

supported

7 179
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
earlyAcmChgNoInd
N/A
Specifies if Charge Indication in Early ACM is always set to

No Indication. (Protocols: all)
supported
echoControl
N/A
Specifies if Echo Control parameter is supported for the ISUP

Signaling Profile.
supported
echoControlInIam
N/A
Secifies if Echo Control parameter supported in IAM for the

supported
N/A
eci
Specifies if the Japan Emergency Indicator parameter is

supported
eciTrap
N/A
If ECI is received in the IAM, call is marked as an emergency

call and a trap is generated. (Protocol: Japan)
supported
egressService
N/A
Specifies if Egress Service parameter is supported for the

supported
N/A
eit
Specifies if EIT is supported for the ISUP Signaling Profile.

supported
emergencyCallInf
N/A
Specifies if Emergency Call Information parameter is

supported in the CPG.
supported
N/A
fac
Specifies if FAC is supported for the ISUP Signaling Profile.

supported
facility
N/A
Specifies if FAA, FAR and FRJ are supported for the ISUP
Signaling Profile.
supported
fallback
N/A
Specifies if Fallback is supported for ISUP Signaling Profile.

supported
7 180

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
fciUserPartChosenCarrie N/A
r
Set flag to supported to overwrite FCI ISDN User Part

indicator based on the Chosen Carrier.
supported
fciUserPartIwk
N/A

indicator for NON-ISUP to ISUP calls.
supported
fciUserPartTrans
N/A

indicator for ISUP to ISUP calls.
supported
forceEchoCntrl
N/A
Set flag to supported to force echo cancellation on calls

regardless of information contained in signalling messages
(with the exception of data calls).
supported
forceEchoCntrlNoUpdate
N/A
When flag is set to supported, Echo Cancelling is enabled,

but ECI bit is not updated.
When set to unsupported, Echo Cancelling is enabled
dependent upon ECI bit. (Protocol: all)
supported
forwardCallProgress
N/A
Set flag to supported to specify that Call Progress (CPG)

message is supported in the forward direction.
supported
forwardGvns
N/A
Specifies if forward GVNS parameter is supported for the

supported
forwardNetworkSpecificI N/A
nfo
Specifies if Forward Network Specific Information parameter is

supported
forwardSuspend
N/A
Specifies if Suspend (SUS) message is supported in the

forwards direction.
unsupported
supported (default)
forwardTransferMessage
N/A
Specifies if Forward Transfer Message is supported for the

unsupported
supported (default)

7 181
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
freePhoneInd
N/A
Specifies if Freephone Indicators parameter is supported for

this ISUP Signalling Profile.
supported
generateJapanIcsParams
N/A
Specifies whether to support generating ICS information in SIP

MIME case for the signalling group.
supported
genericAddressRel
N/A
Specifies if Generic Address parameter is supported in the

REL message for the ISUP Signaling Profile.
supported
genericDigits
N/A
Specifies if Generic Digits parameter supported for the ISUP

Signaling Profile.
supported
genericName
N/A
Specifies if Generic Name parameter is supported for the

supported
genericNotification
N/A
Specifies if Generic Notification parameter is supported for the

supported
genericNotificationInFa N/A
c
Specifies if Generic Notification parameter is supported for the

supported
genericNotificationRepe N/A
atable
Specifies if Generic Notification Repeatable parameter is

supported
genericNumInAcm
N/A
Specifies if Generic Number parameter in the ACM is

supported
genericNumInFac
N/A
Specifies if Generic Number parameter in the FAC is

supported
7 182

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
genericNumInInf
N/A
Specifies if Generic Number parameter in the INF is supported

supported
genericNumber
N/A
Specifies if Generic Number parameter is supported for the

supported
genericNumberInCpg
N/A
Specifies if Generic Number parameter in the CPG is

supported
genericNumberRepeatable N/A
Specifies if generic number is a repeatable parameter.

supported
genericNumberRepeatable N/A
Iam
genericOperation
N/A
Specifies if generic number is a repeatable parameter in IAM.

supported
Specifies if Generic Operation parameter is supported for the
supported
genericReference
N/A
Specifies if Generic Reference parameter is supported for the

supported
N/A
gi
Specifies if GI is supported for the ISUP Signaling Profile.

supported
gr317ScreeningInd
N/A
When set to supported, this flag turns on various screening

indicators for GR317 parameter compliancy.
supported
groupRedirectionCount
N/A
Specifies if Group Redirection Count parameter is supported

supported
hardToReachInd
N/A
Set flag to supported to enable the Hard To Reach Indicator

automatic congestion control parameter for the ISUP Signaling
Profile.
supported

7 183
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
holdingInd
N/A
When set to supported, the sending of a holding request is

supported.
supported (default)
unSupported
hopCountState
N/A
When set to supported the Hop Counter feature is supported

for the Signaling Group.
supported (default)
unSupported
hopCountValue
10-32
The Hop Counter value is used to set the maximum forward

header value, and is used to prevents a loop from happening
when call is made between the PSTN and SIP domain.
(default = 10).
hopCounter
N/A
When set to supported the Hop Counter feature is supported

supported (default)
unSupported
iamGeneratedCarrierCode N/A
InCdr
Set to unsupported to always populate the IAM-Generated

Carrier Code in the CDR for Japan regardless of type.
supported
iepsCpc
N/A
Set flag to supported to allow recognition of Calling Party

Category value IEPS. (Protocols: ITU, China).
supported
incomingTrunkIdCode
N/A
Use this flag to support/not support Incoming Trunk Identity

Code parameter for the ISUP Signaling Profile.
supported
informationInd
N/A
Use this flag to support/not support Information Indicator

parameter for the ISUP Signaling Profile.
supported
inrInAllStates
N/A
Use this flag to support/not support INR and INF messages in

all states for the ISUP Signaling Profile.
supported
inrInf
N/A
Use this flag to support/not support INR/INF for the ISUP

Signaling Profile.
supported
7 184

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
invTnsRelease
N/A
Set this flag to supported to apply the Q931 Release

handling for invalid TNS.
supported
iriOri
N/A
Use this flag to support/not support IRI/ORI for the ISUP

Signaling Profile.
supported
iriOriRcv
N/A
Use this flag to support/not support the reception of IRI/ORI for

supported
iriOriSent
N/A
Use this flag to support/not support sending IRI/ORI messages

supported
isubTypeFromSip
N/A
Use this flag to specify the ISUP type supported. (Protocol:

Japan).
both NSAP and User-Specific ISUB from SIP supported.
none No ISUB types from SIP supported.
nsap (default) Only ISUB of type NSAP from SIP
supported.
userspec only ISUB of type User-Specific from SIP
supported.
ituCai24
N/A
Use this flag to specify if ITU Cause Value 24 Call Rejected

due to Feature at Destination is supported or rejected
(unsupported).
SUPPORTED - ITU Cause Value 24 is recognized.
(Protocols: ITU, China).
supported ITU Cause Value 24 is recognized.
unSupported (default) ITU Cause Value 24 is rejected.
itxTxa
N/A
Are the ITX and TXA messages supported for the ISUP
Signaling Profile.
supported
iui
N/A
Use this flag to specify if IUI6 is supported in the ISUP

Signaling Profile.
supported
jti
N/A
Use this flag to support/not support the JT-specific ISUP

Parameter in the ISUP Signaling Profile.
supported

7 185
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
jurisdiction
N/A
Use this flag to support/not support the Jurisdiction parameter

supported
N/A
ldli
Use this flag to support/not support the Last Diverted Line

Identity parameter for the ISUP Signaling Profile.
supported
locationNumber
N/A
Use this flag to support/not support the Location Number

supported
locationOfRel
N/A
Use flag to specify the REL cause location for SIP MIME case.
locationOfRel34
N/A
internationalNet
natReserved6
natReserved8
natReserved9
natReserved11
natReserved12
natReserved13
natReserved14
natReserved15
netBeyondInterPoint
notUsed (default)
privateLocal
privateRemote
publicLocal
publicRemote
transitNet
user
Use this flag to specify the REL cause 34 location for SIP
MIME case. (default is notUsed)
(see locationOfRel description for list of options)
locationOfRel42
N/A
Use this flag to specify the REL cause 42 location for SIP
MIME case. (default is notUsed)
(see locationOfRel description for list of options)
lookAheadForBusy
N/A
Use this parameter to allow, not allow or reserve path for the
default value in the Look Ahead For Busy field of the ISUP
Precedence parameter within SIP-T.
allowed
notAllowed (default)
pathReserved
7 186

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
loopPrevention
N/A
Use this flag to support/not support the loop prevention

indicators parameter for the ISUP Signaling Profile.
supported
N/A
lpa
Use flag to support/not support Loop Back Acknowledgement

(LPA) requests for the ISUP Signaling Profile.
supported
maRel
N/A
Use this flag to specify if MA6 is supported in the REL

message for the ISUP Signaling Profile.
supported
mapDmsFeParameter
N/A
Use flag to support mapping service group to the Completion

Code in the DMS FE parameter (ANSI ISUP only).
supported
maxCalledPartyDigits
N/A
The maximum digit string length for the Called Party Number
parameter supported for this ISUP Signaling Profile.
maxCallingPartyDigits
N/A
The maximum digit string length for the Calling Party Number
parameter supported for this ISUP Signaling Profile.
mi
N/A
Use this flag to specify if MI6 is supported in the ISUP

Signaling Profile.
supported
mlpp
N/A
Use this flag to specify if MLPP parameter is supported for the

supported
msi
N/A
Use this flag to specify if MSI6 is supported in the ISUP

Signaling Profile.
supported
multiCarrierEnvironment N/A
Use this flag to specify if the Multi-Carrier Environment

parameter is supported for the ISUP Signaling Profile.
supported
ncr
N/A
Use this flag to specify if the Network Call Reference (NCR)

Parameter is supported for ISUP Signaling Profile.
supported

7 187
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
networkData
N/A
Use this flag to specify if Network Data is supported in the IAM

message. (Protocols: ANIS, ITU).
supported
networkIdentity
N/A
The default value used for 4-digit Network Identity field in the
ISUP precedence parameter within SIP-T. (default = 0000).
networkIndicator
N/A
The setting of the Network Indicator as it would be for ISUP if

the SIP-T link were an ISUP link (to prevent unnecessary
interworking - not really applicable to SIP-T).
networkManagement
N/A
int10
int11
nat10 (default)
nat11
Use this flag to specify if Network Management Controls

supported
networkManagementInfo
N/A
Use flag to specify if the Network Management Information

supported
networkSwitchNumber
N/A
Use this flag to specify if the Network Switch Number

supported
networkTransport
N/A
Use this flag to specify if the Network Transport is supported

supported
N/A
nfci
Use this flag to specify if the National Forward Call Indicators

supported
nfciLblRciProc
N/A
Use this flag to specify if the National Forward Call Indicators

Link-by-Link parameter procedure is supported for the ISUP
Signaling Profile.
supported
nfciLnk
N/A
Use this flag to specify if National Forward Call Indicators Linkby-Link parameter is supported for the ISUP Signaling Profile.
supported
7 188

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
nft
N/A
Use this flag to specify if the NFT is supported for the ISUP
Signaling Profile.
supported
N/A
nii
Use this flag to specify if the National Information Indicators

supported
N/A
niri
Use this flag to specify if the National Information Request

Indicators parameter is supported for the ISUP Signaling
Profile.
supported
noAcmObciForSipApn
N/A
Set this flag to supported to prevent SBC from including the

OBCI parameter in the ACM message when interworking to
SIP and the NOA is 0x78 (APN). When interworking with SIP-I
with MIME containing ACM with OBCI, the ACM is transited
with OBCI. (Protocol: Generic).
supported
noChgCountIfFlexChgRate N/A
Set flag to supported to specify that CHG count is not

incremented if there is Flexible Charge Rate. (Protocol:
Japan).
supported
noInNumberUpdates
N/A
Set flag to supported to prevent from updating the called IN

and original called IN number parameters used in Japan
based on the new called party number parameter w hen the
PSX performs a TOLL FREE number translation.
supported
noIpEchoInd
N/A
Use this flag to specify if the Echo Control indication is set for
an IP to PSTN call.
supported
noObciSipAcm
N/A
Set flag to supported for SBC to not include the OBCI

parameter in the ACM in all the existing scenarios. (Protocol:
Generic)
supported
notificationInd
N/A
Use this flag to specify that the Notification Indicator

supported

7 189
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
npfi
N/A
Use this flag to support the Number Portability Forward

Information parameter. (Protocols: ITU, China).
supported
nrmSupport
N/A
Use this flag to support NRM for the ISUP Signaling Profile.
supported
N/A
nrop
Use this flag to support NROP6 in the ISUP Signaling Profile.

supported
N/A
nsa
Use this flag to support the Network Specific ANM parameter

in the ANM.
supported
N/A
nsf
Use this flag to support the NSF parameter for the ISUP
Signaling Profile.
supported
obciAnm
N/A
Use this flag to support OBCI parameter in the ANM for the
supported
olipCheck
N/A
Use this flag to support checking for presence of an OLIP

when determining that a call is invalid.
supported
olipCheckOnSend
N/A
This flag specifies whether to check for presence of an OLIP

when sending an IAM.
supported
N/A
olm
Use this flag to support OLM for the ISUP Signaling Profile.
supported
onlyCpgInBandBeforeAcm
N/A
Set this flag to supported to either transit a CPG containing

an in-band information event arriving before an ACM or
discard CPG when in-band information event is not present.
supported
7 190

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
onlyScreenCitGen
N/A
Use this flag to specify whether to generate screen subparameters in CIT (Protocol: Japan)
supported Generate screen sub-parameters in CIT.
unSupported (default) Generate sub-parameters in CIT
without restrictions.
onlySendAcmFor181
N/A
(ISUP-to-SIP call only) If flag is set to supported, an ACM

message is only sent if a 181 is received. If an ACM has
already been sent, the 181 is mapped to a CPG.
supported
operatorSelection
N/A
Use this flag to support the Operator Selection parameter.

supported
operatorServiceInfo
N/A
Use this flag to support Operator Service Information

supported
N/A
opr
Use this flag to support Operator (OPR) message.

supported
optionalFci
N/A
This flag specifies whether the Optional Forward Call

Indicators is supported for the ISUP Signaling Profile.
supported (default)
unSupported
N/A
This flag specifies whether the Original Called Number

supported
originatingIscPointCode N/A
This flag specifies whether the originating ISC point code

supported
otgnAnsi92
N/A
This flag specifies whether the OTGN Parameter (up to 5

octets) is supported in the EXM message.
supported
otherDigitStringSpecial N/A
DigitF
This flag specifies whether the Special Digit F is supported in

digit strings other than the Called Party.
supported

7 191
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
overrideInBand
N/A
Set flag to supported to ignore Inband indicator in OBCI or

Event Indicator in CPG message unless Interworking Indicator
is set for BCI. (Protocols: all)
supported
N/A
pam
This flag specifies whether PAM is supported for ISUP

Signaling Profile.
supported
pciPassOnDefault
N/A
Use flag to specify whether to support necessary information

exchange when receiving an unrecognized PCI Pass On Not
Possible value in the ISUP Signaling Profile.
supported
N/A
pcli
This flag specifies whether Partial Calling Line Identity

supported
presentationNumber
N/A
This flag specifies whether the Presentation Number

supported
preventAcmToCpgMapping
N/A
If an ACM is sent on the ingress trunk group due to a script

and T11 timer expires (or some other event), if an ACM is
received on the egress trunk group it is usually converted into
a CPG message on the ingress trunk group.
Set this control to supported to prevent ACM-to-CPG
mapping and silently discard the received ACM on the ingress
side.
supported
propagationDelay
0-400
propagationDelaySupport N/A
The propagation delay value (in milliseconds) for this SIP-T

signaling group. (default = 0)
This control specifies whether propagation delay is supported
supported
qor
N/A
Use this flag to specify whether the Query on Release

parameter is supported. (Protocols: ITU, China)
supported
7 192

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
reaffirmBlockAfterReset N/A
If set to supported, when RSC or GRS is sent on a locallyblocked circuit, BLO is also sent to reaffirm the blocking.
supported
recommendationInCai
N/A
Use flag to specify whether Recommendation field is

supported in the cause parameter for the ISUP Signaling
Profile.
supported
redirectingNumber
N/A
Use flag to specify whether the Redirecting Number parameter

is supported for the ISUP Signaling Profile.
supported
redirectionCap
N/A
Use flag to specify whether Redirection Capability parameter

is supported for the ISUP Signaling Profile.
supported
redirectionInfoAcm
N/A
Use flag to specify whether the Redirection Information

parameter is supported in the ACM message for the ISUP
Signaling Profile.
supported
redirectionInfoIam
N/A
Use flag to specify whether the Redirection Information

parameter is supported within the IAM message foe the ISUP
Signaling Profile.
supported
redirectionNumRestricti N/A
onInRel
Use this flag to specify whether to support Redirection Number

Restriction Parameter in the REL message. (Protocols: ITU,
China).
supported
redirectionNumber
N/A
Use this flag to specify whether to support Redirection Number

supported
redirectionNumberInAcm
N/A
Use this flag to specify whether the redirection number is

supported in the ACM for the ISUP Signaling Profile.
supported
redirectionNumberInAnm
N/A
Use this flag to specify whether the redirection number is

supported in the ANM for the ISUP Signaling Profile.
supported

7 193
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
redirectionNumberRestri N/A
ction
Use this flag to specify whether the redirection number

restriction parameter is supported for the ISUP Signaling
Profile.
supported
relForDuplicateIam
N/A
Use this flag to specify which message to send when a

misplaced call is detected. (Protocols: all)
supported Send a REL with CV=31 to clear the circuit.
unSupported (default) Send an RSC to clear the circuit.
relForEarlyAnm
N/A
Use this control to specify action to take if an ANM is received

before a backward message (Protocols: ITU, Japan, China).
supported Send REL cause 31 in both directions.
unSupported (default) Reattempt the call.
releaseLinkTrunking
N/A
Use this control to specify whether the Release Link Trunking

(RLT) Service is supported.
supported
remoteMnpDip
N/A
Use this control to specify whether Remote MNP Dipping

service is supported.
supported
remoteOperationInRel
N/A
Use this control to specify whether Remote Operations

parameter is supported in the REL for ISUP Signaling Profile.
supported
remoteOperations
N/A
Use this control to specify whether Remote Operations

supported
removeHlcIfNoLlc
N/A
Set control to supported to remove HLC if LLC is not present.

(Protocols: all).
supported
revision
N/A
Select the ISUP protocol revision supported on this Signaling

Group. (default is ituq767).
ansi1992 | ansi1995 | ansiatt | argentina |
argent | inaidt | belgacom | brazil | chile |
chinacnc | denmarkic | etsi2 | etsi2plus |
etsi3 | hongkongic | india | israel | italy |
itu1988 | itu1993 | itu1997 | |ituq767 | korea
| mexicoic | nttcom | nttfcc | peru |
portugaloni | russia | singapore | slovak2 |
spain | spirou | ukisup
7 194

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
rlcAcknowledgeGrs
N/A
Use this control to specify whether to support acknowledging a

GRS with an RLC message.
supported
routeInformation
N/A
Set this control to supported to allow SBC to process the

Route Information parameter received in the IAM message,
and enable KGL-specific routing. (Protocol: ITU)
supported
routingInfoInd
N/A
Use this control to specify whether the Routing Information

Indicator parameter is supported for ISUP Signaling Profile.
supported
N/A
rr
Use this control to specify whether the RR6 is supported in the

supported
russiaRng
N/A
Use this control to specify whether the Russia RNG message

is supported. (Protocol: Russia)
supported
saveIamCit
N/A
Use this control to specify whether or not to save CIT

information (Protocol: Japan).
supported CIT information in the IAM will not be
overwritten by backwards information.
unSupported (default) Existing functionality and IAM
CIT can be overwritten.
sccpProcedure
N/A
Use this control to specify if SCCP procedure is supported for

supported
scfId
N/A
Use this control to specify if the SCF ID parameter is

supported
screenCitBeforeCdr
N/A
Use this control to specify action to take against CIT before

applying to CDR. (Protocol: Japan)
supported SBC screens out any carrier information
transfer data that will not be sent in the signaling message
and stores this information in the CDR.
unSupported (default) SBC adds all the carrier
information transfer parameter data to the CDR and screens
out any unneeded data before generating the signaling
message.

7 195
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
sdnIncrement
N/A
Use this control to specify whether to support the SDN SID/

ANI Increment Message for the ISUP Signaling Profile.
supported
segmentation
N/A
Use this control to specify whether to support segmentation for

supported
sendBloOnHwBlock
N/A
Set to supported to send BLO when a circuit is hardware

blocked.
supported
sendRscForCallsOnHwBloc N/A
k
Set to supported to send RSC when a call is impacted by a

circuit hardware blockage.
supported
sendTwoGroupMsgs
N/A
Set the flag to support sending two group messages in the

supported
sendingEnbloc
N/A
Set this flag to allow the trunk group to only send enbloc
(Protocols: ITU, China).
supported Trunk group will only send enbloc.
unSupported (default) Trunk group can send overlap
and enbloc.
serviceActivation
N/A
Set this flag to support the service activation parameter for the
supported
serviceActivationInRel
N/A
Set this flag to support the Service Activation Parameter in the

REL message.
supported
serviceCodeInd
N/A
Set this flag to support Service Code Indicator parameter for

supported
sgmPci
N/A
Set this flag to support the PCI parameter in the SGM for the
supported
7 196

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
signalOnlySipAlert
N/A
Set this control to only allow generation of ACM/CPG

message during an ISUP-to-SIP call in response to an 180
message.
supported
signalingPointCode
N/A
Set this control to support the signaling point code parameter

supported
simpleEcBciInAllBkMsg
N/A
Set this control to support simple echo control whereby every

backward message is examined for the BCI echo control
indication field, and then appropriate action is taken.
supported
sliInIam
N/A
Set this control to support the Supplementary Line Info

parameter in the IAM.
supported
slovakChargeMessage
N/A
Use this flag to support the Slovak charge message. (Protocol:

Slovak)
supported
N/A
spc6
Use this flag to support SPC6 in the ISUP Signaling Profile.

supported
spcInIrs
N/A
Use this flag to support the SPC parameter with the IRS
message for the ISUP Signaling Profile.
supported
specialDigits
N/A
Use this control identify which special digits can appear in

dialed digit strings (select all that apply).
specialProcessReq
N/A
digitA BIT 0
digitB BIT 1 (default)
digitC BIT 2 (default)
digitD BIT 3
digitE BIT 4
digitF BIT 5 (default)
none BIT 6
Use this flag to support the Special Processing Request

supported

7 197
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
storeChargeForIscTcType N/A
AndPayPhone
Use this control to specify which Charge Information is stored

in CDR. (Protocol: Japan)
supported The First Charge Information is stored in the
CDR Records.
unSupported (default) The Last Charge Information is
stored in the CDR Records.
subscriberPriorityClass N/A
Set this flag to support the subscriber priority class parameter

supported
subsequentAddressMessag N/A
e
Set this flag to support the Subsequent Address Message for

supported (default)
unSupported
suppressCitForPreSubAcm N/A
Set this flag to ensure the Carrier Information Transfer

parameter is suppressed in Early ACM for Pre-Subscription
call.
supported
t7Transit
N/A
Set flag to run the T7 Timer for a Transit Call in the ISUP
Signaling Profile.
supported
t11Active
N/A
Set flag to specify that ISUP T11 timing is active at

interworking exchanges for Signaling Profile.
supported
t11EarlyAcm
N/A
Set flag to enable ISUP T11 Early ACM guard timer for the
supported
tandemCallCounter
N/A
Set this flag to allow SBC to decode/encode, increment and

transit the Tandem Call Counter parameter received in IAM
message. (Protocol: Japan)
supported
tandemLimitCounter
0-15
Specify value of Limit Counter set in outgoing IAM in Tandem

Call Counter parameter in SIP MIME case. (default = 0)
tci
N/A
Specify if TCI is supported for the ISUP Signaling Profile.

supported
7 198

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
tit
N/A
Set flag to support the TIT parameter for the ISUP Signaling
Profile.
supported
tmrPrime
N/A
Set flag to support TMR prime parameter for the ISUP

Signaling Profile.
supported
transMedUsedInNrm
N/A
Set flag to support TMU parameter within the NRM Message

supported
transactionReq
N/A
Set flag to support Transaction Request parameter for the

supported
transferInfo
N/A
Set flag to decode and transit Transfer Info parameters.

(Protocol: Japan)
supported
transitCfn
N/A
Set flag to transit the CFN message for the ISUP Signaling
Profile.
supported
transitNetworkSelection N/A
Set flag to support the Transit Network Selection parameter for

supported
transitReceivedCit
N/A
Use this flag to specify whether to modify received CIT

parameter. (Protocol: Japan)
supported Transit the received CIT parameter as-is.
unSupported (default) Modify received CIT parameter
as usual.
transitUnrecognized
N/A
Use this flag to support transiting unrecognized parameters for

the ISUP service Group.
supported
transmissionMediumUsed
N/A
Set flag to support the Transmission Medium Used parameter

supported

7 199
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
truncateCdpn
N/A
Use this flag to specify whether to truncate or release the call if

the CDPN is greater than the MaxCalledPartyDigits.
supported Truncate the call.
unSupported (default) Release the call.
trunkOfferingSupport
N/A
Set flag to support trunk offering messages can, fan, ofr, rcl
(presently, this only applies to mexico).
supported
u2uServiceLevel
N/A
Use flag to specify the level of user-to-user services supported

in the ISUP Signaling Profile.
N/A
ucic
implicit (default)
level1
level2
level3
none
Set flag to support UCIC for the ISUP Signaling Profile.

supported
uidActionInd
N/A
Set flag to support UID Action Indicators parameter for the

supported
uidCapabilityInd
N/A
Set flag to support UID Capabilities parameter for the ISUP

Signaling Profile.
supported
uniqueTransitCit
N/A
Use this control to define transit carrier data (Protocol: Japan).

supported The SBC compares the transit carrier code
configured on the PSX with the last carrier code added by
the previous exchange. If both are transit and have the
same carrier code, the SBC does not add in duplicate
information. The ingress signaling profile controls checking
backward messages and the egress signaling profile
controls checking forward messages.
unSupported (default) The SBC adds transit carrier data
with the same carrier code as the previous code if
configured by the PSX.
upaUpt
N/A
Set flag to support UPA/UPT for the ISUP Signaling Profile.

supported
7 200

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
updateAnmBci
N/A
Use flag to specify how to treat BCI in ANM (Protocol: Japan).

supported BCI in ANM is taken from last received in
ACM or CPG; charge indicator is updated.
unSupported (default) BCI in ANM set to default if not
present.
updateInternalNetworkIn N/A
dicatorInCalledPartyNum
ber
Use this parameter to specify how to update the Internal

Network Indicator in the Called Party Number.
updateNumberIncompleteI N/A
ndicatorInCallingPartyI
ndicator
This parameter is used to update the Number Incomplete

Indicator in the Calling Party Number.
upvExchangeRoles
N/A
transit (default) Value received is unchanged.

allowed Internal Network Indicator may be updated.
notAllowed Internal Network Indicator may not be
updated.
transit (default) Value received is unchanged.

complete The delivered number is marked as complete.
incomplete The delivered number is marked as
incomplete.
Use this control to identify the exchange roles allowed to
perform Unrecognized Parameter Value (UPV) handling. By
default, BITs 0-5 are selected.
usePsxChgIndForCpgInPre N/A
subCall
orig (BIT 0) Originating exchange

term (BIT 1) Terminating exchange
intwk (BIT 2) Interworking exchange
trans (BIT 3) Transit exchange
int (BIT 4) International exchange
unknown (BIT 5) Unknown exchange
none (BIT 6) No exchange roles allowed
Set flag to use the PSX ACM charge indicator to overwrite the
charge indicator field of the BCI for CPG messages, or leave
as unSupported to transit the value received.
supported
userServiceInformation
N/A
Set flag to support User Service Information (information sent

in forward direction indicating bearer capability requested by
calling party) for the ISUP Signaling Profile.
supported (default)
unSupported
userTeleService
N/A
Set flag to support User Teleservice parameter for the ISUP

Signaling Profile.
supported

7 201
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
usiPrime
N/A
Set flag to support the USI Prime parameter for the ISUP
Signaling Profile.
supported
N/A
usr
Set flag to support USR parameter for the ISUP Signaling

Profile.
supported
uuIndAcm
N/A
This flag specifies whether the User-to-User Indicators

parameter is supported in ACM for the ISUP Signaling Profile.
supported (default)
unSupported
uuIndCon
N/A

parameter is supported in CON for ISUP Signaling Profile.
supported (default)
unSupported
uuIndInFar
N/A

Parameter is supported in FAR for ISUP Signaling Profile.
supported
uuIndRel
N/A

Parameter is supported in REL for the ISUP Signaling Profile.
supported (default)
unSupported
uuInfo
N/A
This flag specifies whether the User-to-User Information

supported (default)
unSupported
uuInfoAcm
N/A
This flag specifies whether the UU Information is supported in

the ACM for the ISUP Signaling Profile.
supported (default)
unSupported
uuiInInf
N/A
This flag specifies whether the User-to-User Information

parameter is supported in the INF.
supported
uuiRestrictions
N/A
(Protocol: Japan)
Set flag to discard subsequent UUIs based on BCI field values
received in ACM/CPG.
supported
7 202

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
uuindAnm
N/A
Set flag to support the UUI parameter in the ANM for the ISUP
Signaling Profile.
supported
N/A
uuindCpg
Set flag to support the UUI parameter in the CPG for the ISUP
Signaling Profile.
supported
N/A
validateIsubFromSip
Set this flag to validate ISUB from SIP. (Protocol: Japan)

supported The SBC ensures only digits 0-9 are allowed
in the NSAP ISUB from SIP.
unSupported (default) The SBC does not check the
ISUB digits.
versionId
visitorMa
10065535
Enter version ID to identify a signaling group.
N/A
Set this flag to support Visitor MA parameter.
NOTE: version IDs 0-99 are reserved for seed data.

supported
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 to globalize. The
profile includes a digit type, a source for the country code, and a flag to enable the
globalization.
Command Syntax
% set profiles signaling numberGlobalizationProfile <profile
name>
entry
252
253
254
billingNumber
calledInNumber
calledNumber
callingNumber
7 203
CLI Reference Guide

Profiles
Signaling
contractorNumber
dialedNumber
fromUri
gnAdditionalCalled
gnAdditionalCalling
gnCalledCesId
gnCollectCallNumber
gnDestination
gnDialedDigits
gnLocalAni
gnPortedDialed
gnThirdPartyNumber
location
none
outpulseNumber
presentationNumber
pretranslated
redirecting
redirection
twoStageCollected
countryCodeSource <destination|ingressTrunkgroup|
origination>
digitType
900PremiumToll
950CarrierAccess
all
carrierAccess
directoryAssistance
emergency
7 204

CLI Reference Guide

Signaling
Profiles
governmentEmergency
ieps
internationalType
ipVpn
localOperator
nationalOperator
nationalType
noDigits
otherCarrierChosen
private
serviceAccessCode
subscriberOperator
subscriberType
test
tollFree
transit
userName
verticalServiceCode
globalize <disable|enable>
% show profiles signaling numberGlobalizationProfile
<profile name>
entry <type of number to be analyzed>
countryCodeSource
digitType
globalize
% delete profiles signaling numberGlobalizationProfile
<profile_name>
Command Parameters
TABLE 7 46 Number Globalization Profile parameters
Parameter
Length/
Range
numberGlobalizationP 1-23
rofile
Description
The Globalization Number Profile name.

7 205
CLI Reference Guide

Profiles
Signaling
TABLE 7 46 Number Globalization Profile parameters (Continued)

Parameter
Length/
Range
entry
N/A
Description
Specifies a unique identifier for the globalize profile. The possible
values are:
countryCodeSource
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
redirecting
twoStageCollected
Use this parameter to identify the country code source.

destination (default)
ingressTrunkgroup
origination
7 206

CLI Reference Guide

Signaling
Profiles
TABLE 7 46 Number Globalization Profile parameters (Continued)

Parameter
Length/
Range
digitType
N/A
Description
Digit type of the number to globalize. The possible values are:
globalize
N/A
900PremiumToll
950CarrierAccess
all
carrierAccess
directoryAssistance
emergency
governmentEmergency
ieps
internationalType
ipVpn
localOperator
nationalOperator
nationalType
noDigits
otherCarrierChosen
private
serviceAccessCode
subscriberOperator
subscriberType
test
tollFree
transit
userName
verticalServiceCode
Enable flag to perform number globalization.

disable (default)
enable
displaylevel
1-64

commands.

7 207
CLI Reference Guide

Profiles
Signaling
Command Example
% show profiles signaling numberGlobalizationProfile
numberGlobalizationProfile DEFAULT_IP
{
entry callingNumber
{
digitType
subscriberType,nationalType,internationalType,easilyId
entifiableNumber,tollFree,900PremiumToll,950CarrierAcc
ess,directoryAssistance,serviceAccessCode,test,transit
,otherCarrierChosen,carrierAccess,noDigits;
countryCodeSource origination;
globalize
enable;
}
entry calledNumber
{
digitType
countryCodeSource destination;
globalize
enable;
}
entry pretranslated {
digitType
countryCodeSource destination;
globalize
enable;
7 208

CLI Reference Guide

Signaling
Profiles
SCTP Profile
Stream Control Transmission Protocol (SCTP) is a transport layer protocol similar
to TCP, but is characterized as message-oriented protocol transporting a
sequence of messages (each being a group of bytes) rather than an unbroken
stream of bytes (TCP behavior). In SCTP, a sender sends a message in one
operation, and that exact message is passed to the receiving application process
in one operation.
The SCTP as a Transport preference and SCTP retransmission timer are
configured from the SIP Trunk Group.
The SCTP as a transport protocol and SCTP profile are configured in the SIP
signaling port.
The SCTP Profile CLI syntax is described below.
Command Syntax
% set profiles signaling sctpProfile <profile name>
heartbeatInterval <# seconds>
idleTimeout <# seconds>
inboundStreams <#>
initRetry <#>
orderedDelivery <disabled|enabled>
outboundStreams <#>
pathMtu <#bytes>
peerTransportAddresses <# addresses>
retransmissionsPerAssociation <#>
retransmissionsPerPath <#>
rtoInitial <# milliseconds>
rtoMax <# milliseconds>
rtoMin <# milliseconds>
sackDelay <disabled|enabled>

7 209
CLI Reference Guide

Profiles
Signaling
Command Parameters
TABLE 7 47 SCTP Profile parameters
Parameter
Length/
Range
Description
sctpProfile
N/A
Name of SCTP profile.
heartbeatInterval
1-6
The SCTP Heartbeat Interval in seconds. (default = 4)
idleTimeout
0-86400
SCTP Idle Timeout Interval in seconds. (default = 3600)
inboundStreams
1-32
The number of Inbound Streams for this SCTP profile.

(default = 1)
initRetry
1-10
The SCTP Max INIT retry. (default = 8)
orderedDelivery
N/A
Enable flag to use ordered delivery in SCTP.

disabled (default)
enabled
outboundStreams
1-32
The number of Outbound Streams for this SCTP profile.
pathMtu
1000-1500 The SCTP Path MTU in bytes. (default = 1500)
peerTransportAddresses
1-2
The number of Peer Transport Addresses for this SCTP

profile. (default = 1)
retransmissionsPerAsso
ciation
0-20
The Maximum retransmissions per SCTP association.

(default = 0)
retransmissionsPerPath
1-10
The number of Retransmissions per path for this SCTP

profile. (default = 8)
rtoInitial
50-500
The SCTP RTO Initial in milliseconds. (default = 50)
rtoMax
200-5000
The SCTP RTO Max in milliseconds. (default = 200)
rtoMin
10-5000
The SCTP RTO Min in milliseconds. (default = 40)
sackDelay
N/A
Set flag to enable SACK Delay in SCTP.

disabled (default)
enabled
Command Example
In this example, the following steps are accomplished:
1. Create SCTP profile named SCTP02 with following configuration:

outboundStreams - 2, inboundStreams - 2, peerTransportAddress - 2,
retransmissionsPerPath - 8, hearbeatInterval - 6, orderedDelivery - enabled,
retransmissionPerAssociatioon - 1, rtoInitial - 100, rtoMax - 200, rtoMin - 50.
2. Configure SCTP as a transport protocol in SIP signaling port, and SCTP

profile SCTP02 is associated with the particular zone.
3. Configure SCTP as a Transport preference and SCTP retransmission timer to

50 seconds in the SIP Trunk Group.
4. Configure SCTP as a transport protocol in IP Signaling Profile.
7 210

CLI Reference Guide

Signaling
Profiles
Step 1:
% set profiles signaling sctpProfile SCTP02 outboundStreams
2 inboundStreams 2 peerTransportAddresses 2
retransmissionsPerPath 8 heartbeatInterval 6
orderedDelivery enabled retransmissionsPerAssociation 1
rtoInitial 100 rtoMax 200 rtoMin 50
% show profiles signaling sctpProfile SCTP02
outboundStreams
2;
inboundStreams
2;
peerTransportAddresses
2;
retransmissionsPerPath
8;
heartbeatInterval
6;
orderedDelivery
enabled;
retransmissionsPerAssociation 1;
rtoInitial
100;
rtoMin
50;
rtoMax
200;
Step 2:
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS sipSigPort
2 transportProtocolsAllowed sip_sctp
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS sipSigPort
2 sctpProfileName SCTP02
Step 3:
sipTrunkGroup TG_SIPART_AS signaling transportPreference
preference1 1
sipTrunkGroup TG_SIPART_AS signaling timers
sctpRetransmitTimer 10
Step 4:
egressIpAttributes transport type1 sctp

7 211
CLI Reference Guide

Profiles
Signaling
Signaling Profile
Use this feature to specify parameters that are sent as part of the outgoing
signaling message (ISUP, CAS, PRI) after standard protocol rules are applied.
You can associate signaling profiles with carriers and trunk groups. A signaling
profile can also be used to enable selected ingress call processing functions.
Signaling Profile entity is used for both IP and virtual trunk groups in conjunction
with the IP Signaling Profile.
Command Syntax
% set profiles signaling signalingProfile
DEFAULT_IP_PROFILE
SIGPROFILE_ANSI00
SIGPROFILE_ANSI88
SIGPROFILE_ETSI121
SIGPROFILE_ETSI356
SIGPROFILE_GR317
SIGPROFILE_ITU_T88
SIGPROFILE_ITU_T92_PLUS
SIGPROFILE_TTC87
SIGPROFILE_TTC93_PLUS
% set profile signaling signalingProfile <profile name>
accessTransport <disable|enable>
egress
PartitionIdNetIdInNetworkIdIAM
generatePartitionIdNetIdInNetworkIdIAM
<disable|enable>
propagatePartitionIdNetIdInNetworkIdIAM
<disable|enable>
callingName <dontSend|noInput|send>
callingNumber <dontSend|noInput|send>
cft
egressCftInfo <offnet|onnet|unknown>
chargeNumber <dontSend|noInput|send>
cip <dontSend|noInput|send>
csp <dontSend|noInput|send>
donorSwitchService
7 212

CLI Reference Guide

Signaling
Profiles
createCalledDirectoryNumberInEgressSignal
<disable|enable>
generateRedirectionCount <disable|enable>
skipRedirectionAfterNumberTranslations
<disable|enable>
undoDonorSwitchService <disable|enable>
egressFlags
(each of following flags uses <disable|enable> option)
addPrefix1ForInterLataCalls
addPrefix1ForIntraLataCalls
addPrefix011ForInternationalCalls
annexESupport
applySwitchTypeCpcProfile
callBackWhenFreeSupport
calledNumber7Digits
callingNumber7Digits
changeBearerCapFrom3_1KHzToSpeech
convertNumbersToE164Format
cpcMapping
dialedNumberAsCalledNumber
disableChargingAuthorityForChosenCarrier
discardCallingAndContractNumbers
discardGAPAddlClgIfSameAsClgNumberAndIngressSIP
discardTnsAndTrunkgroupOwningCarrierMatch
dontStripClgNumberForRestrictedPresentation
forcedOverrideOlipValue
generateFeParam
oliMapping
overwriteChargeInformationIfChosenIXC
performCalledPartyMemberCheck
propagateChargeMessage
propagateGdParam
reorderTrunkBasedOnIsupPreference
replacePrefix0WithPlus81ForTranslationSourceNumber
rerouteOnSignalingCongestion
resetOlipForTollFreeCalls
restoreCallingNumberIfDerivedFromBillingNumber
restoreCallingNumberIfDerivedFromRedirectingNumber
restoreCallingNumberIfDerivedFromTrunkGrp
restoreFciInternationalBit
sendBillingNumberAsClgNumber
sendBillingNumberAsClgNumberIfClgNumberNotPresent
sendCallingNumberWhenNotDerivedFromInput

7 213
CLI Reference Guide

Profiles
Signaling
sendContractNumberIfAllowedByIngressSip
sendTollFreeNumberInGapParam
sendTollFreeNumberInOcnParam
stripRepAreaCodeDigits
transitAllRedirectionNumberNOA
undoLnp
forcedClip
<allowed|none|numberUnavailable|restricted|spare>
ipDoubleDipControlFlags
calledNumberFromAltCalledNumber <disable|enable>
restoreIngressNumbersExceptTranslatedNumbers
<disable|enable>
restoreTranslatedNumbers <disable|enable>
skipEgressTrunkGrpProcessing <disable|enable>
isupTrustedNetwork <none|trusted|unTrusted>
jip <dontSend|noInput|send>
mobileCallDelivery
origcldNumber <dontSend|noInput|send>
redirectionInformation <dontSend|noInput|send>
olip <dontSend|noInput|send>
origCalledNumber <dontSend|noInput|send>
redirectCapability <disable|enable>
redirectCount <disable|enable>
redirectInformation <disable|enable>
redirectingNumber <dontSend|noInput|send>
redirectionCapabilityFlags
enableRedirectionCapability <disable|enable>
tnsFlags
interLataLocal <dontSend|noInput|send>
interLataToll <dontSend|noInput|send>
international <dontSend|noInput|send>
internationalOperator <dontSend|noInput|send>
intraLataLocal <dontSend|noInput|send>
intraLataToll <dontSend|noInput|send>
localOperator <dontSend|noInput|send>
longDistanceOperator <dontSend|noInput|send>
nationalOperatorInterServiceArea
<dontSend|noInput|send>
nationalOperatorIntraServiceArea
<dontSend|noInput|send>
7 214

CLI Reference Guide

Signaling
Profiles
ukIsup
nfciDefaultValues
cliBlockingAvailable <disable|enable>
nfciLinkToLinkRoutingControlIndicator
<altRtAllowedContRetryAllowed|
altRtAllowedContRetryBarred|altRtBarredContRetry
Allowed|altRtBarredContRetryBarred|altRtOnceCont
RetryAllowed|altRtOnceContRetryBarred|none>
visitorMa <dontSend|noInput|send>
genericDigitType
accountCode
authorizationCode
bcgIdentity
billToNumber
pnTravellingClassmark reserveOffset
spare00
spare0A
spare0B
spare0C
spare0D
spare0E
spare0F
spare01
spare02
spare03
spare04
spare05
spare06
spare07
spare08
spare09
spare10
unknown
ingress
cft
sendCftInformation <disable|enable>
ingressFlags
(each of following flags uses <disable|enable> option)
disallowMissingCallingNumber
disallowTnsAndTrunkGroupOriginatingCarrierMatch
disallowWithoutBillingNumber
disallowWithoutOlip
discardRedirectionBackwardInformation
discardRedirectionCountForRelease
dontGenerateExitMessage
enableRedirectionCapabilty
feParamInShortForm
generateChargeMessage
generateCpgForCallForwardNotify
inboundTnsAllowed
normalizeCarrierCode
performCallingPartyScreening
performCpcScreening
propagateEgressChannelInfo
propagateFeParam
separateAlertFromProgressForSipInterworking
treatCic0000AsNoCic
7 215
CLI Reference Guide

Profiles
Signaling
useIsupRelOnSusTimer
validateGapTypePortedNumber
internationalGatewaySupport
dontConvertCalledNumber <disable|enable>
dontConvertCallingNumber <disable|enable>
natureOfAddress
<international|national|networkSpecific|passThrough|
subscriber|unknown>
transitCarrierIndicator
<backward|bidirection|forward|noTransmission|nonProvis
ioned|oredBackward|oredForward|passThrough>
userToUserInformation <disable|enable>
Command Parameters
TABLE 7 48 Signaling Profile parameters
Parameter
Length/
Range Description
signalingProfile
1-23
Signaling Profile name.
accessTransport
N/A
Enable flag to include Access Transport parameter in messages in

the forward or backward direction before messages are sent over the
associated trunk group.
disable
enable (default)
egress
N/A
Use this object to configure egress trunk group parameters.

PartitionIdNetIdInNetworkIdIAM Controls network
data in IAM.
generatePartitionIdNetIdInNetworkIdIAM
Enable flag to use Partition ID and Network ID specified on
the ingress Trunk Group to populate the Network Data
parameter in the IAM sent over the egress trunk group.
disable (default)
enable
propagatePartitionIdNetIdInNetworkIdIAM
Enable flag to use Partition ID and Network ID received in
the ingress IAM by the SBC to populate the Network Data
parameter in the IAM sent over the egress trunk group.
disable (default)
enable
callingName Specifies whether to send the calling name as
a part of the out going signaling protocol.
dontSend
noInput (default)
send
7 216

CLI Reference Guide

Signaling
Profiles
TABLE 7 48 Signaling Profile parameters (Continued)

Parameter
Length/
Range Description
egress (continued)
N/A
callingNumber Specifies whether to send the calling name

as a part of the out going signaling protocol.
dontSend
noInput (default)
send
cft Controls the Egress confirmation tone.
egressCftInfo Specifies type of confirmation tone
information of SIP calls that egress SBC sends to SIP server.
offnet (default)
onnet
unknown
chargeNumber Specifies whether to send the charge
number as a part of the outgoing signaling protocol or not.
dontSend
noInput (default)
send
cip Specifies whether to send Carrier Information Parameter
(CIP) as a part of the outgoing signaling protocol.
dontSend
noInput (default)
send
csp Specifies whether to send CSP as a part of the outgoing
signaling protocol or not.
dontSend
noInput (default)
send
donorSwitchService Controls the donor switch service.
The options are:
createCalledDirectoryNumberInEgressSignal This
check box is applicable only when the Donor Switch Service
has been executed.
disable (default)
enable
generateRedirectionCount When enabled, the SBC
adds redirection counter to egress IAM.
disable (default)
enable
skipRedirectionAfterNumberTranslations When
enabled, the PSX skips looking into several tables for
redirection once number translation is complete for Donor
switch service.
disable (default)
enable

7 217
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
egress (continued)
N/A
7 218
undoDonorSwitchService When enabled, even when

the Donor Switch Service is executed, the egress signal
contains the Called Party number containing the Dialed
Number.
disable (default)
enable
egressFlags Specifies various egress trunk group controls.
addPrefix1ForInterLataCalls When enabled,
allows the addition of the prefix "1" for Inter LATA calls.
disable (default)
enable
addPrefix1ForIntraLataCalls When enabled,
allows the addition of the prefix "1" for Intra LATA calls.
disable (default)
enable
addPrefix011ForInternationalCalls When
enabled, allows the addition of the prefix 011 for international
calls.
disable (default)
enable
annexESupport Annex E is supported.
disable (default)
enable
applySwitchTypeCpcProfile When enabled, it
enables the CPC/OLI Parameter Mapping feature on the
associated trunk group(s).
disable (default)
enable
callBackWhenFreeSupport When enabled, it enables
the Call Back When Free feature on the associated trunk
group(s)
disable (default)
enable
calledNumber7Digits When enabled, the 7-digit called
number is sent as part of the outgoing signaling protocol
disable (default)
enable
callingNumber7Digits When enabled, the 7-digit
calling number is sent as part of the outgoing signaling
protocol.
enable
disable (default)

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
egress (continued)
N/A
changeBearerCapFrom3_1KHzToSpeech The bearer

capability of 3.1 kHz received from the ingress is reset to
speech for this outgoing trunk group.
disable (default)
enable
convertNumbersToE164Format When enabled,
numbers are converted to E.164 format.
disable (default)
enable
cpcMapping When enabled, it enables the CPC mapping
on the associated trunk group(s).
disable (default)
enable
dialedNumberAsCalledNumber When enabled, the
PSX populates the called number (associated with a
returned route) with the dialed number.
disable (default)
enable
disableChargingAuthorityForChosenCarrier
When enabled, the SBC does not delete the ISUP
parameters from the ACM and CPG messages, and it allows
the CHG message to transit when it is acting as the chosen
carrier.
disable (default)
enable
discardCallingAndContractNumbers When
enabled, the SBC will not include calling and contractor
numbers in egress signaling when calling number NOA is
Network Specific and the first digit of the calling number is
not 0, or the calling number screening is set to User
Provided, Verified, and Failed.
disable (default)
enable
discardGAPAddlClgIfSameAsClgNumberAndIngressS
IP When enabled, for SIP-to-ISUP calls the SBC does not
include the GAP additional calling number in the egress
signaling if it is the same as the original calling number.
disable (default)
enable
discardTnsAndTrunkgroupOwningCarrierMatch
When enabled, it causes the TNS parameter to be discarded
when it matches the Owning Carrier assigned to the egress
trunk group.
disable (default)
enable

7 219
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
egress (continued)
N/A
7 220
dontStripClgNumberForRestrictedPresentation
When enabled, the PSX does not strip (delete) the digits of
the calling number for restricted presentation.
disable (default)
enable
forcedOverrideOlipValue When enabled, and there
is a value other than none in the Forced OLIP Value field in
the ingress section of the trunk group to which this signaling
profile is applied, the value in that field is copied to the OLI
parameter on the egress trunk and sent in the PSX policy
response.
disable (default)
enable
generateFeParam When enabled, controls the
generation of the FE parameter.
disable (default)
enable
oliMapping When enabled, it enables the OLI parameter
mapping on the associated trunk group(s).
disable (default)
enable
overwriteChargeInformationIfChosenIXC When
enabled, the SBC will modify the parameters related to
charge indication if the value of the Carrier type parameter
determined by the PSX is Chosen IXC.
disable (default)
enable
performCalledPartyMemberCheck When enabled, the
PSX checks the called party member status in the subscriber
table for the JTI prefix.
disable (default)
enable
propagateChargeMessage When enabled, the PSX
propagates the CRG messages received on the associated
egress trunk group from succeeding exchanges to the
originating exchange for billing purposes.
disable (default)
enable
propagateGdParam When enabled, it controls the
propagation of the Generic Digits parameter (switch ID/trunk
group ID) in the forward direction in the egress IAM.
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
egress (continued)
N/A
propagateIngressChannelInfo When enabled,

propagate ingress PSTN channel information in the INVITE
header sent by a SBC to this SIP Server (via the "chan"
parameter in the From: field).
disable (default)
enable
reorderTrunkBasedOnIsupPreference When
enabled, the PSX orders route lists appropriately for calls
over ISUP trunks that terminate to a protocol converter for
R2 signaling.
disable (default)
enable
replacePrefix0WithPlus81ForTranslationSourceN
umber When enabled, and the translation source number
has the prefix 0, PSX replaces the prefix 0 with +81.
disable (default)
enable
rerouteOnSignalingCongestion When enabled, calls
on the associated trunk group are rerouted to an alternate
route.
disable (default)
enable
resetOlipForTollFreeCalls When enabled, the SBC
resets the OLIP for toll free calls to the pay phone code.
disable
enable (default)
restoreCallingNumberIfDerivedFromBillingNumbe
r When enabled, the calling number that came in the policy
request is sent in the policy response.
disable (default)
enable
restoreCallingNumberIfDerivedFromRedirectingN
umber When enabled, and if the PSX derives the calling
number from the redirecting number during call processing,
the PSX restores the original calling number before sending
it in the policy response.
disable (default)
enable

7 221
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
egress (continued)
N/A
7 222
restoreCallingNumberIfDerivedFromTrunkGrp
When enabled, and if the PSX derives the calling number
from the default calling number associated with the ingress
trunk group during call processing, the original calling
number is restored before the call is sent out on the egress
trunk group.
disable (default)
enable
restoreFciInternationalBit When enabled, the
PSX copies the incoming FCI A-bit to the outgoing FCI A-bit.
disable (default)
enable
sendBillingNumberAsClgNumber When enabled, the
PSX populates the contents of the billing number over to the
calling party parameter.
disable (default)
enable
sendBillingNumberAsClgNumberIfClgNumberNotPre
sent When enabled, and if the calling number doesn't
exist or the calling number presentation is set to Restricted,
the PSX populates the calling number field in the policy
response with the billing number.
disable (default)
enable
sendCallingNumberWhenNotDerivedFromInput
When enabled, and if the calling number doesn't exist or the
calling number presentation is set to Restricted, the PSX
populates the calling number field in the policy response with
the billing number.
disable (default)
enable
sendContractNumberIfAllowedByIngressSip
When enabled, and and the ingress signaling is SIP, the
contractor number, if it exists, will be sent in the egress
signaling.
disable (default)
enable
sendTollFreeNumberInGapParam When enabled, the
toll free number will be sent in the Generic Address
Parameter (GAP).
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
egress (continued)
N/A
sendTollFreeNumberInOcnParam When enabled, the

toll free number will be sent in the Original Called Number
(OCN) parameter. The options are:
disable
enable (default)
stripRepAreaCodeDigits When enabled, RAC digits
are removed from the called party number. The options are:
disable (default)
enable
transitAllRedirectionNumberNOA When enabled,
the PSX informs the SBC to forward the R-REL transparently
to the previous switch regardless of the Nature Of Addresss.
The options are:
disable (default)
enable
undoLnp When enabled, the SBC undoes LNP on the
associated trunk group(s). The options are:
disable (default)
enable
useOutputANIForCDNIS When enabled, the Automatic
Number Identification (ANI) to be included in the egress
signaling is used for the ANI provisioned in the Custom DNIS
DM rule on the associated egress trunk group.
disable (default)
enable
forcedClip The Forced CLIP field in the signaling profile of
the egress Trunk Group is used to set the presentation of the
calling number (or generic number) that is sent to the SBC in
the Policy Response.
allowed
none (default)
numberUnavailable
restricted
spare
ipDoubleDipControlFlags Specifies the flags that are
used to control scenarios where there are two policy request/
policy response sequences per call.
calledNumberFromAltCalledNumber When enabled,
the alternate called number (the called number with a prefix
added in response to Auto Recall Prefix Profile processing)
is copied to the called number in the policy response.
disable (default)
enable

7 223
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
egress (continued)
N/A
7 224
restoreIngressNumbersExceptTranslatedNumbers
When enabled, the PES process restores all numbers
except translated numbers to the ones received in the policy
request or SIP INVITE message before including them in the
response to the originating gateway during the first PSX
lookup.
disable (default)
enable
restoreTranslatedNumbers When enabled, the PES
process restores translated numbers received in the policy
request or SIP INVITE message before including them in
response to originating gateway during the first PSX lookup.
disable (default)
enable
skipEgressTrunkGrpProcessing When enabled, PES
skips any processing on the first dip that changes numbers
during or after the PSX post-router phase.
disable (default)
enable
isupTrustedNetwork This flag is used as part of the
presentation restriction functionality to discard the calling party
number or generic number of type additional calling party
number at an international exchange as per Recommendation
Q.731.
none (default)
trusted
unTrusted
jip When enabled, the Jurisdiction Information Parameter is
sent as part of the outgoing signaling protocol for Inter LATA
and Intra LATA conformance.
dontSend
noInput (default)
send
mobileCallDelivery Controls the signaling parameters in
Mobile calls.
origCldNumber: When the option Send is selected, it
causes the PSX to send the original called number in the
egress IAM.
dontSend
noInput (default)
send

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
egress (continued)
N/A
redirectionInformation When the option Send is

selected, it causes the PSX to send the redirection
information in the egress IAM.
dontSend
noInput (default)
send
olip When the option Send is selected, the OLIP is sent as
a part of the outgoing signaling protocol. The options are:
dontSend
noInput (default)
send
origCalledNumber When the option Send is selected, the
OCN is sent as part of the outgoing signaling protocol. The
options are:
dontSend
noInput (default)
send
redirectCapability When enabled, it includes the ANSI
ISUP Redirect Capability parameter in the IAM that are sent on
the egress trunk group if the parameter was received in the
ingress IAM.
disabled
enable (default)
redirectCount When enabled, it includes the ANSI ISUP
Redirect Count parameter in the IAM that are sent on the
egress trunk group if the parameter was received in the ingress
IAM.
disabled
enable (default)
redirectInformation When enabled, it includes the
Redirect Information parameter in any messages in either in the
forward or in the backward direction before they are sent over
the associated trunk group.
disabled
enable (default)
redirectingNumber When the option Send is selected,
the redirecting number is sent as part of outgoing signaling
protocol.
dontSend
noInput (default)
send

7 225
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
egress (continued)
N/A
7 226
redirectionCapabilityFlags Controls the signaling

parameters call redirection scenarios.
enableRedirectionCapability: When enabled, it
causes the Redirection capabilities to be sent in the policy
response to SBC.
disable (default)
enable
tnsFlags Controls TNS parameter for various call types.
interLataLocal When the option Send is selected, the
TNS is sent as a part of the outgoing signaling protocol for
inter LATA (Service Area) local calls.
dontSend
noInput (default)
send
interLataToll When the option Send is selected, the
inter LATA (Service Area) toll calls.
dontSend
noInput (default)
send
international When the option Send is selected, the
IDDD calls.
dontSend
noInput (default)
send
internationalOperator When the option Send is
selected, the TNS is sent as a part of the outgoing signaling
protocol for 0+IDDD calls.
dontSend
noInput (default)
send
intraLataLocal When the option Send is selected, the
intra LATA (Service Area) local calls.
dontSend
noInput (default)
send
intraLataToll When the option Send is selected, the
TNS is sent as part of the outgoing signaling protocol for intra
LATA (Service Area) toll calls.
dontSend
noInput (default)
send

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
egress (continued)
N/A
localOperator When the option Send is selected, the

local operator calls.
dontSend
noInput (default)
send
longDistanceOperator When the option Send
selected, the TNS is sent as a part of the outgoing signaling
protocol for 00 (Long Distance Operator) calls.
dontSend
noInput (default)
send
nationalOperatorInterServiceArea When the
option Send is selected, the TNS is sent as a part of the
outgoing signaling protocol for 0+ Inter-LATA operator.
dontSend
noInput (default)
send
nationalOperatorIntraServiceArea When the
option Send is selected, the TNS is sent as part of the
outgoing signaling protocol for 0+ Intra-LATA operator.
dontSend
noInput (default)
send
ukIsup This parameter controls UK ISUP parameters.
nfciDefaultValues Specifies the National Forward Call
Indicator (NFCI) default values.
cliBlockingAvailable When interworking a nonUK ISUP variant to UK ISUP, enable flag to allow CLI
blocking in the NFCI parameter of the outgoing UK ISUP
IAM.
- disable (default)
- enable
nfciLinkToLinkRoutingControlIndicator Use this
object to select Link-to-Link routing control options.
altRtAllowedContRetryAllowed Select to allow
alternate routes and continuous retries.
altRtAllowedContRetryBarred Select to allow
alternate routes but bar continuous retries.
altRtBarredContRetryAllowed Select to bar
alternate routes but allow continuous retries.
altRtBarredContRetryBarred Select to bar both
alternate routes and continuous retries.
altRtOnceContRetryAllowed Select to allow
alternate route once and allow continuous retries.

7 227
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
altRtOnceContRetryBarred Select to allow
alternate route once but to bar continuous retries.
none
visitorMa When the option Send is selected, the Visitor
MA (Message Area) parameter is sent as part of the outgoing
signaling protocol.
dontSend
noInput (default)
send
egress (continued)
genericDigitType
N/A
Specifies the generic digit type which has to be interpreted to

contain the switch ID and Trunk Group ID.
ingress
N/A
Use this object to specify ingress trunk group signaling profile

parameters.
cft: Controls Ingress Confirmation Tone.
sendCftInformation: When enabled, for SIP calls, the
egress SBC will send confirmation tone (CFT) information
(whether the call is considered On-Net or Off-Net) to the SIP
server.
disable (default)
enable
ingressFlags: Specifies the various controls that applies to
ingress Trunk group.
disallowMissingCallingNumber: When enabled, the
Calling Party Validation feature is enabled, which disallows
calls that do not contain a calling party number.
disable (default)
enable
disallowTnsAndTrunkGroupOriginatingCarrierMat
ch: When enabled, disallows the calls when the TNS
parameter matches the originating carrier assigned to the
ingress trunk group.
disable (default)
enable
disallowWithoutBillingNumber: When enabled,
disallows the calls to be completed if there is no billing
number.
disable (default)
enable
disallowWithoutOlip: When enabled, all calls without
OLIP will be rejected.
disable (default)
enable
7 228

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
ingress (continued)
N/A
discardRedirectionBackwardInformation: When
enabled, the PSX informs the SBC to discard the backward
redirection information parameter received in REL.
disable (default)
enable
discardRedirectionCountForRelease: When
enabled, the PSX informs the SBC to discard the redirection
count parameter.
disable
enable (default)
dontGenerateExitMessage: When enabled, controls the
generation of the EXM message on the associated ingress
trunk group.
disable (default)
enable
enableRedirectionCapabilty: When enabled,
redirection capabilities are enabled on the ingress trunk
group.
disable (default)
enable
feParamInShortForm: When enabled, the SBC generates
the FE parameter in the short form.
disable (default)
enable
generateChargeMessage: When enabled, the PSX
generates charge band information for billing purposes and
sends the information to the SBC in policy responses on a
per-route basis.
disable (default)
enable
generateCpgForCallForwardNotify: When enabled,
PSX instructs the SBC to send CPGs (call progress
messages) in a backward direction, releasing the ingress leg.
disable (default)
enable
inboundTnsAllowed: When enabled, calls with a TNS
parameter in the ingress signaling will be processed.
disable (default)
enable

7 229
CLI Reference Guide

Profiles
Signaling

Parameter
ingress (continued)
Length/
Range Description
7 230
normalizeCarrierCode: When enabled, all Carrier

Codes used in processing calls will be converted to four
digits by appending a "0" if required.
disable (default)
enable
performCallingPartyScreening: When enabled, the
PSX performs calling party screening and retrieves the
configured member status from the subscriber table.
disable
enable (default)
performCpcScreening: When enabled, the PSX will
perform Calling Party Category (CPC) screening to
determine if this call should be restricted based on the
received CPC.
disable (default)
enable
propagateEgressChannelInfo: When enabled, it
propagates the egress PSTN channel information in SIP 18x/
200 or Final Response messages returned by a SBC to this
SIP Server (via the "chan" parameter in the To: field).
disable (default)
enable
propagateFeParam: When enabled, it controls the
propagation of the FE parameter in the backward directions
for call arriving on the associated trunk group.
disable (default)
enable
separateAlertFromProgressForSipInterworking:
When enabled, controls the propagation of the FE parameter
in the backward directions for call arriving on the associated
trunk group.
disable (default)
enable
treatCic0000AsNoCic: When enabled, calls arriving with
carrier code 0000 are treated as if there is no carrier code.
disable (default)
enable
useIsupRelOnSusTimer: When enabled, and the called
party goes on hook, the SBC starts the SUS (Suspend) timer
and releases the call when the SUS timer expires.
disable (default)
enable

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
ingress (continued)
internationalGatewayS N/A
upport
natureOfAddress
N/A
Controls the International Gateway behavior.

dontConvertCalledNumber For international calls, if the
destination country and the country code of the egress trunk
group are the same, the called number is converted into the
national number, and the country code is stripped from the
digits.
disable (default)
enable
dontConvertCallingNumber For international calls, if the
destination country and the country code of the egress trunk
group are the same, the calling number is converted into an
international number by adding the country code of the ingress
trunk group.
disable (default)
enable
Specifies the type of IP address.
transitCarrierIndicat N/A
or
userToUserInformation N/A
validateGapTypePortedNumber: When enabled, the

SoftSwitch verifies that the Generic Address Parameter
(GAP) type field is set to Ported Number.
disable (default)
enable
international
national
networkSpecific
passThrough
subscriber
unknown (default)
Specifies the Transit Carrier Indication.
backward
bidirection
forward
noTransmission (default)
nonProvisioned
oredBackward
oredForward
passThrough
Enable flag to include the User-to-User parameter in any

messages in either the forward or backward direction before
messages are sent over the associated trunk group.
disable
enable (default)

7 231
CLI Reference Guide

Profiles
Signaling
Command Example
For SIP calls, to send confirmation tone (CFT) information to the SIP sever:
% set Profiles signaling signalingProfile DEFAULT_IP_PROFILE
ingress cft sendCftInformation enable
To disallow calls to be completed, if there are no billing numbers:
ingress ingressFlags disallowWithoutBillingNumber enable
To reject calls without OLIP:
ingress ingressFlags disallowWithoutOlip enable
For the PSX to perform Calling Party Category (CPC) screening to determine if
the call has to be restricted based on the received CPC:
ingress ingressFlags performCpcScreening enable
Signaling QoS KPI Profile

QoS-based routing towards a terminating gateway/subscriber is configurable from
both a signaling and a media perspective. For Media QoS KPI Profile, see "Media
QoS KPI Profile" on page 7 60
The Signaling Quality of Service (QoS) Key Performance Indicator (KPI) Profile
provides a mechanism to calculate the various signaling KPIs to measure
signaling QoS-related routing parameters, and use the results to make informed
decisions when routing calls.
Since these constraints are very dynamic, a utilization factor for each route is
configurable on PSX/ERE for the route. This utilization factor is then provided to
SBC 5x00 as part of the route attributes, and is used by SBC 5x00 to filter out any
route/trunk group failing the criteria.
Command Syntax
CLI syntax to configure a Signaling QoS KPI Profile:
% set profiles signaling signalingQosKpiProfile
<profile_name>
asr <disable|enable>
asrThreshold <0-100>
clu <disable|enable>
cluThreshold <0-100>
kpiExpression <0-255 characters>
pgrd <disable|enable>
pgrdThreshold <50-10000>
7 232

CLI Reference Guide

Signaling
Profiles
profileActive <disable|enable>
scru <disable|enable>
scruThreshold <0-100>
CLI syntax to assign Signaling QoS KPI Profile to IP Signaling Profile:
egressIpAttributes signalingQosKpiProfile
<signalingQosKpiProfile_name>
Command Parameters
TABLE 7 49 Signaling QoS KPI Profile Parameters
Parameter
Length/
Range
Description
1-23
QoS KPI profile name.
asr
N/A
Use this flag to enable Answer Seizure Ratio (ASR) KPI.

disable (default)
enable
asrThreshold
0-100
ASR threshold (default = 70).
clu
0-100
Use this flag to enable Call Limit Utilization (CLU) KPI.

disable (default)
enable
cluThreshold
0-100
CLU threshold (default = 70)
kpiExpression
1-255
Enter the expression defining this KPI.

Default is ASR&&CLU&&SCRU&&PGRD where &&
operation means that only when all the KPIs in the
expression are good, will a route be chosen for carrying
traffic. If any are bad, the route is rejected for that
particular call from the list of routes available from Policy
response.
If the only available route is rejected, the call is dropped.
Other configurable examples:
ASR||CLU||SCRU||PGRD
ASR&&(CLU||SCRU)
ASR&&CLU||ASR&&SCRU
N/A
pgrd
Use flag to enable Post-Gateway Ringing Delay (PGRD)

KPI.
disable (default)
enable
pgrdThreshold
50-10000 PGRD threshold in milliseconds. (default =1000).

7 233
CLI Reference Guide

Profiles
Signaling
TABLE 7 49 Signaling QoS KPI Profile Parameters (Continued)

Parameter
Length/
Range
Description
profileActive
N/A
Use flag to enable this profile.

disable (default)
enable
N/A
scru
Use flag to enable SCRU KPI.

disable (default)
enable
0-100
scruThreshold
Sustained Call Rate Utilization (default = 70)
Command Example
This example creates and enables a QoS KPI profile named MyQosProfile, and
enables ASR and CLI KPIs. The ASR threshold is set to 55 while CLU
thresholds is left at default value of 70.
With the next two commands, MyQosProfile is associated with DEFAULT_SIP
IP Signaling Profile and QoS-based routing is enabled.
% set profiles signaling signalingQosKpiProfile MyQosProfile
asr enable asrThreshold 55 clu enable profileActive
enable
% show profiles signaling signalingQosKpiProfile
MyQosProfile
profileActive enable;
asr
enable;
asrThreshold
55;
clu
enable;

egressIpAttributes signalingQosKpiProfile MyQosProfile
7 234

CLI Reference Guide

Signaling
Profiles
SIP Adaptor Profile

The SIP Adaptor Profile object is the main construct for SIP Message
Manipulation (SMM) functionality. A SIP Adaptor Profile is associated with a SIP
Trunk Group or Zone in order to act upon SIP messages passing into or out of that
group.
A SIP Trunk Group can have two SIP Adaptor Profiles, an input adaptor profile for
manipulation of inbound messages, and an output adaptor profile for manipulation
of outbound messages.
Similarly, a Zone can have two SIP Adaptor Profiles.
An SBC 5x00 can have up to 256 SIP Adaptor Profiles.
Command Syntax
Use following CLI syntax to configure a SIP Adaptor profile.
% set profiles signaling sipAdaptorProfile <profile_name>
rule <rule_index_#>
action <action_index_#>
from type
globalVariable globalVariableValue
egressTgName
ingressTgName
localIP
localPort
sigportid
srcipaddr
srcport
undefined
header value <string>
messageBody messageBodyValue <all|undefined>
parameter value <string>
token tokenValue
undefined
uridisplayname
urihostname
urihostport
urischeme
uriusername
value value <string>
variable value <undefined|var1-var30>
headerInfo <fieldValue|headerValue|undefined>
headerPosition <first|last|undefined>

7 235
CLI Reference Guide

Profiles
Signaling
operation <add|append|createuri|delete|ignore|
modify|regappend|regdel|regpostdel|regpostsub|
regpredel|regprepend|regpresub|regstore|regsub|
reject|rename|store|undefined>
paramType <generic|undefined|uri|userinfo>
regexp
matchInstance <all|one|two|three|four|five|last>
string <string>
to type <header|messageBody|parameter|token|
variable>
type <header|messagse|messageBody|parameter|token|
undefined|variable>
applyMatchHdrRange <two|three|four|five|six|seven|
eight|nine|ten|last|undefined>
applyMatchHeader <one|two|three|four|five|six|seven|
eight|nine|ten|all|last>
criterion <criterion_index_#> type
globalVar globalVariable
condition <absent|exist|has-value|not-equalto|regex-match|undefined>
globalVariableID
<egressTgName|ingressTgName|localIP|localPort
|sigportid|srcipaddr|srcport|undefined>
regexp
string <string>
numMatch <match|notmatch>
value <string>
header header
hdrInstance <one|two|three|four|five|six|seven|
eight|nine|ten|all|last>
hdrRange <two|three|four|five|six|seven|
eight|nine|ten|last|undefined>
name <string>
numberOfInstances
number <#>
qualifier <equal|greater|lessthan|undefined>
regexp
string <string>
value <string>
message message
7 236

CLI Reference Guide

Signaling
Profiles
messageTypes
<all|request|requestAll|response|responseAll|
undefined>
methodTypes <ack, bye, cancel, info, invite,
message, notify, options, prack, publish,
refer, register, subscribe, update>
statusCode <code_#>
statusRange <#>
messageBody messageBody
messageBodyType <all|undefined>
regexp
string <string>
parameter parameter
name <string>
paramType <generic|undefined|uri|userinfo>
regexp
string <string>
value <string>
token
regexp
string <string>
tokenType <undefined|uridisplayname|urihostname|
urihostport|urischeme|uriusername>
value <string>
variable
regexp
string <string>
value <string>
variableID <undefined|var1-var30>
% set profiles signaling sipAdaptorProfile <profile_name>

7 237
CLI Reference Guide

Profiles
Signaling
Command Parameters
SIP Adaptor Profile
TABLE 7 50 SIP Adaptor Profile parameters
Parameter
Length/
Range
Description
sipAdaptorProfile
1-256
Specifies the name of the SIP Adaptor profile.
rule
1-64
Use this object to define the SIP Message Manipulation (SMM) rule
within the SIP Adaptor Profile. Specify the SSM rule index number,
and then configure the parameters as listed in Table 7 51 on
page 7 238.
state
N/A
The administrative state of this SIP PDU Manipulation entry.

disabled (default)
enabled
SIP Adaptor Profile Rule

TABLE 7 51 SIP Adaptor Profile Rule Parameters
Parameter
Length/
Range Description
rule
1-64
7 238
The index number of SMM rule within the SIP Adaptor Profile.

CLI Reference Guide

Signaling
Profiles
TABLE 7 51 SIP Adaptor Profile Rule Parameters (Continued)

Parameter
Length/
Range Description
action
1-20
Specify Action index, and then configure associated parameters as

shown below.
<actionId#> (range: 1-20)
from type Use to configure source message parameters.
globalVariable globalVariableValue Specify the
global variable to take action against (default is undefined).
egressTgName|ingressTgName|localIP|localPort|
sigportid|srcipaddr|srcport|undefined
NOTE: Do not use egressTgName or ingressTgName in a
SMM profile defined at the Zone level. These parameters
can only be used in an outputAdaptor profile.
header value Enter the header value.
messageBody messageBodyValue Select message body
type (default is all): <all|undefined>
parameter value Enter the parameter value.
token tokenValue Specifies the token type (default is
undefined).
undefined|uridisplayname|urihostname|urihostp
ort|urischeme|uriusername
value value Enter the from string value of this action
entry. (range: 1-128 characters).
variable variableValue The ID of the internal
variable to apply with this action. Options are: undefined, or
in range of var1-var30.
headerInfo The type of Header information (default is
undefined): fieldValue|headerValue|undefined
headerPosition The header position of add header action:
first|last|undefined (default)
operation The operation type of this SIP PDU manipulation
action entry.
add Add a header, parameter, token or messageBody
using configured value.
append Append a configured value to a variable.
createuri message uriInfo Create a SIP URI using
following sub-parameters. The SIP URI is stored in the
specified variable. The to type for this operation is a
variable.
uriDisplayName URI display name (string or variable)
[optional].

7 239
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
action (continued)
N/A
uriHostName URI host name (string, variable or global

variable).
uriHostPort URI host port (string, variable or global
variable) [optional].
uriScheme URI scheme (string or variable).
uriUserName URI user name (string or variable).
NOTE: Use createuri operation for any header
except Request-Line, From and To headers.
7 240
delete Delete a header, parameter or a token.

ignore Drop a message silently on the inbound leg, and
do not send on the outbound leg.
modify Modify header value, parameter, and token using
configured value or regular expression-based text
manipulation, or else modify messageBody content using
regular expression based text manipulation only.
regappend Insert configured value after the matching
substring.
regdel Delete the matching substring.
regpostdel Delete the part after the matching substring.
regpostsub Replace the part after the matching substring
regpredel Delete the part before the matching substring.
regprepend Insert configured value before the matching
substring.
regpresub Replace the part before the matching substring
regstore Store the matching substring to a variable or the
regular expression sub-expression matches into a range of
variables.
regsub Replace the matching substring using configured
value.
reject message Reject a message by the value
configured in the response code (applies to request
messages only).
reject responseCode (100-699)
rename Rename a header.
store Store a parameter, a variable or header value into a
variable.
undefined Default value.

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
action (continued)
N/A
paramType Parameter type:

generic
undefined (default)
uri
userinfo
regexp Specifies the regular expression string against which
comparison is performed to find the matches.
matchInstance Apply the action associated with a
regular expression to a particular match instance.
one (default)
two
three
four
five
last
all
string The regular expression text of this action entry.
to Use to configure destination message parameters.
type This value displays the following options:
header value <string> Enter the header value.
messageBody messageBodyValue Select message
body type (default is undefined)
<all|undefined>
parameter value <string> Enter parameter value.
token tokenValue Select token type to act upon.
undefined|uridisplayname|urihostname|
urihostport|urischeme|uriusername
variable Use this object to specify variable range,
variable scope and variable values:
- variableRangeValue <var1..var30|undefined>
- variableScopeValue <local|message>
- variableValue <var1..var30|undefined>
type The action type of this SIP PDU manipulation entry.
header
message
messageBody
parameter
token
undefined
variable

7 241
CLI Reference Guide

Profiles
Signaling

Parameter
Length/
Range Description
applyMatchHdrRange
N/A
The range of the filtered header instances which are to be

modified. The following is the valid set of values for this field:
applyMatchHeader
N/A
This value specifies the matching header. The following are the
valid set of values for this field:
7 242
two
three
four
five
six
seven
eight
nine
ten
last
undefined (default)
all
one (default)
two
three
four
five
six
seven
eight
nine
ten
last

CLI Reference Guide

Signaling
Profiles

Parameter
Length/
Range Description
criterion
1-20
Identifies the SIP PDU manipulation Criterion.

globalVar Specifies for which value of the global variable
the rule is applicable. The criteria must be present in global
variable rules.
condition The pattern matching condition of this SIP
PDU Manipulation criterion entry. (default is undefined)
absent|exist|has-value|not-equal-to|
regex-match|undefined
globalVariableID Details the global variable type of this
SIP PDU Manipulation entry. (default is undefined):
egressTgName|ingressTgName|localIP|
localPort|sigportid|srcipaddr|srcport|
undefined
NOTE: egressTgName and ingressTgName can only be
used in an outputAdaptor profile.
NOTE: Do not use egressTgName or ingressTgName in a
SMM profile defined at the Zone level.
regexp Options are:
numMatch Apply the criterion associated with a number
match for a regular expression.
- match
- noMatch
string The regular expression text of this criterion
entry.
value The criterion's value of this SIP PDU Manipulation
criterion entry.
header Specify the header for which the rule is applicable.
absent|exist|has-value|not-equal-to|regexmatch|undefined
hdrInstance Apply criteria on header instance number
(default is all).
all|eight|five|four|last|nine|one|seven|six|
ten|three|two
hdrRange This is an optional upper range of header
instances. (default is undefined)
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:

7 243
CLI Reference Guide

Profiles
Signaling

Parameter
criterion
(continued)
7 244
Length/
Range Description
N/A
number Criterion required to have total number of

header instance.
qualifier The total number of headers matching this
condition. (default is undefined)
equal|greater|lessthan|undefined
regexp Specifies the regular expression string against
which comparison would be performed to find the matches.
match for a regular expression. (default is match)
match|noMatch
string Regular expression text of this criterion entry.
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. (default is undefined)
all|request|requestAll|response|responseAll|
undefined
methodTypes The SIP PDU manipulation method types of
this rule entry. (default is )
ack|bye|cancel|info|invite|message|notify|
options|prack|publish|refer|register|
subscribe|update
statusCode The status code of SIP PDU manipulation
rule. (range: 100-699 / default = 0).
statusRange The status code range of SIP PDU
manipulation rule. (range: 100-699 / default = 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

CLI Reference Guide

Signaling
Profiles

Parameter
criterion
(continued)
Length/
Range Description
N/A

Options are:
match|notmatch
parameter The parameter for which the rule is applicable.
This criteria element must be present in Parameter rules.
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. (default is undefined)
generic|undefined|uri|userinfo
of match for a regular expression. (default is match)
match|notmatch
criterion entry.
token Specifies the token type to act upon by the action
Options are:
match for a regular expression. Options are:
match|notmatch
entry.
tokenType Details the token type of this SIP PDU
Manipulation entry. (default is undefined)
undefined|uridisplayname|urihostname|
urihostport|urischeme|uriusername

7 245
CLI Reference Guide

Profiles
Signaling

Parameter
criterion
(continued)
Length/
Range Description
N/A

criterion entry.
variable The ID of the internal variable to apply with this
Action.
match|notmatch
criterion entry.
variableID Details the variable type of this SIP PDU
Manipulation entry.
<undefined|var1-var30>
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;
}
7 246

CLI Reference Guide

Signaling
Profiles
}
}
}
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
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

7 247
CLI Reference Guide

Profiles
Signaling
SIP/CPC Cause Code Mapping Profile

The following topics are included in this section:
"CPC to SIP Cause Map Profile" on page 7 249

"Internal SIP Cause Map Profile" on page 7 251
"SIP to CPC Cause Code Mapping Profile" on page 7 252
The above Cause map profiles provide customized tables on the SBC 5x00 to
map cause codes between internal, 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.
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 doesnt 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:
7 248
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

CLI Reference Guide

Signaling
Profiles
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 SBC 5x00 to locate the corresponding CPC-toSIP 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
defaultCpcSip
baseProfile <defaultCpcSip|defaultQ1912CpcSip|
defaultRfc3398CpcSip|defaultTs29163CpcSip>
causeMap <CPC cause value>
includeQ850Reason <disabled|enabled>
unrecAction
<q1912Procedure|rfc3398Procedure|ts29163Procedure>
defaultQ1912CpcSip
unrecAction
defaultRFC3398CpcSip
unrecAction
7 249
CLI Reference Guide

Profiles
Signaling
defaultTs29163CpcSip
unrecAction
% show profiles signaling sipCauseCodeMapping
cpcToSipCauseMapProfile <cpcToSipCauseMapProfile>
% delete profiles signaling sipCauseCodeMapping
<cpcToSipCauseMapProfile>
Command Parameters
TABLE 7 52 CPC SIP Cause Code Mapping Profile Parameters
Parameter
Length/
Range
cpcToSipCauseMapProf 1-23
ile
Description
The name of the CPC-to-SIP Cause Mapping Profile. The default
profiles available are:
baseProfile
1-23
defaultSipCpc
defaultQ1912SipCpc
defaultRFC3398SipCpc
defaultTs29163SipCpc
The name of the default SIP-to-CPC Mapping Profile on which to

base this new profile.
defaultCpcSip
defaultQ1912CpcSip
defaultRfc3398CpcSip
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 using the set command.
7 250

CLI Reference Guide

Signaling
Profiles
TABLE 7 52 CPC SIP Cause Code Mapping Profile Parameters (Continued)

Parameter
Length/
Range
causeMap
N/A
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 SIP-I signaling. Must
be 0- 127; default is 0.
A value of 0 indicates that the Reason Header Q.850 value
should be equal to the predefined ISUP mapping associated
with the CPCCAUSE value. If no predefined ISUP mapping
exists (as for internal cause codes 151-159), the ISDN
mapping is used.
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.
includeQ850Reason
N/A
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 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
Internal SIP Cause Map Profile

Use this feature to configure specific SIP response codes to particular internal SIP
request rejections from SIP Service Group.
Command Syntax
internalSipCauseMapProfile <profile_name> causeMap

7 251
CLI Reference Guide

Profiles
Signaling
otherReqRatePolicing sipCause <300-606>

regRatePolicing sipCause <300-606>
regTGLimit sipCause <300-606>
regTimeout sipCause <300-606>
subsRatePolicing sipCause <300-606>
subsTGLimit sipCause <300-606>
Use following CLI syntax to attach an Internal SIP Cause Map profile to a SIP
trunk group.
sipTrunkGroup <TG_NAME) signaling causeCodeMapping
sipInternalCauseMappingProfile <profile_name>
Command Parameters
TABLE 7 53 Internal SIP Cause Mapping Profile Parameters
Parameter
Length/
Range Description
internalSipCauseMap 1-23
Profile
causeMap
N/A
Internal SIP Cause Map Profile name.

Use this object to configure custom SIP cause response codes.
otherReqRatePolicing Cause code when a message rate
other than REGISTER or SUBSCRIBE exceeds IP trunk groups
maximum configured value.
regRatePolicing Cause code when REGISTER message
rate exceeds IP trunk groups maximum configured value.
regTGLimit Cause code when current REGISTRATION
exceeds IP trunk groups maximum registration limit.
regTimeout Cause code from REGISTER request timeout.
subsRatePolicing Cause code when SUBSCRIBE
message rate exceeds IP trunk groups maximum configured
value.
subsTGLimit Cause code when current Subscription on IP
trunk group exceeds maximum configuration limit.
NOTE: For each of the above status codes, assign a
sipCause ID in range of 300-606.
SIP to CPC Cause Code Mapping Profile

This profile provides information about each SIP-to-CPC Cause Mapping Profile
on the node.
Command Syntax
7 252

CLI Reference Guide

Signaling
Profiles

sipToCpcCauseMapProfile <sipToCpcCauseMapProfile>
loc3xx <locNxx>
loc4xx <locNxx>
loc5xx <locNxx>
loc6xx <locNxx>
locBye <locBye>
locCancel <locCancel>
cancelCause <cancelCause>
baseProfile <baseProfile>
causeMap <causeMap> cpcCause <cpcCause>
% show profiles signaling sipCauseCodeMapping
sipToCpcCauseMapProfile <sipToCpcCauseMapProfile>
% delete profiles signaling sipCauseCodeMapping
<sipToCpcCauseMapProfile>
Command Parameters
TABLE 7 54 SIP to CPC Cause Code Mapping Profile Parameters
Parameter
Length/
Range
sipToCpcCauseMapProf 1-23
ile
Description
The name of a SIP-to-CPC Cause Map Profile. 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
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.

7 253
CLI Reference Guide

Profiles
Signaling
TABLE 7 54 SIP to CPC Cause Code Mapping Profile Parameters (Continued)

Parameter
Length/
Range
cancelCause
N/A
The Q850 cause value that the SIP CANCEL message should
generate. RFC3398 specifies 16 (normal clearing), whereas
Q1912.5 specifies 31 (normal unspecified). The respective
default profiles contain these mappings but this provides a user
override to the default mapping. Must be 1-127.
causeMap
N/A
Specifies the SIP-to-CPC cause mapping values. The possible

values are:
Description
400
413
483
503
401 402 403 404 405 406 407 408 410

414 415 416 420 421 423 480 481 482
484 485 486 487 488 493 500 501 502
504 505 513 580 600 603 604 606
cpcCause
N/A
CPC Cause value for a given SIP cause value. Must be 1-127.
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
when a SIP BYE message is received:
user
localPrivateNetwork
localLocalNetwork
transitNetwork
remoteLocalNetwork
and in defaultRFC3398SipCpc.
7 254

CLI Reference Guide

Signaling
Profiles
TABLE 7 54 SIP to CPC Cause Code Mapping Profile Parameters (Continued)

Parameter
Length/
Range
locCancel
N/A
Description
when a SIP CANCEL message is received:
user
localPrivateNetwork
localLocalNetwork
transitNetwork
remoteLocalNetwork
and in defaultRFC3398SipCpc.
Command Example
Following is an example of creating new CPC-to-SIP and SIP-to-CPC profiles,
and then associating the profiles to a trunk group.
cpcToSipCauseMapProfile INGRESS_CPC_TO_SIP baseProfile
sipToCpcCauseMapProfile INGRESS_SIP_TO_CPC baseProfile
defaultRfc3398SipCpc
TG_SIPART signaling causeCodeMapping
cpcSipCauseMappingProfile INGRESS_CPC_TO_SIP
TG_SIPART signaling causeCodeMapping
sipCpcCauseMappingProfile INGRESS_SIP_TO_CPC

7 255
CLI Reference Guide

Profiles
SIP CAC Profile
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, bandwidth size, call rates, oversubscription amounts,
burst sizes, etc.
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 <profile_name>
bandwidthLimit <0-2147483647>
callEgressAggregateEmergencyPreference <1-10>
callEgressAggregatePreference <1-10>
callEgressBurstSize <1-500>
callEgressEmergencyPreference <disabled|enabled>
callEgressRate <1-500, unlimited>
callEgressRatePeriod <1-10>
callIngressAggregateEmergencyPreference <1-10>
callIngressAggregatePreference <1-10>
callIngressBurstSize <1-500>
callIngressEmergencyPreference <disabled|enabled>
callIngressRate <1-500, unlimited>
callIngressRatePeriod <1-10>
callLimit <0-30000, unlimited>
callLimitEgress <0-30000, unlimited>
callLimitIngress <0-30000, unlimited>
emergencyOversubscriptionEgress <0-1000>
emergencyOversubscriptionIngress <0-1000>
7 256

CLI Reference Guide

SIP CAC Profile
Profiles
// Optional parameters to configure a SIP CAC profile

% set profiles sipCacProfile <profile_name>
aggregateMessage
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10)
dblAggregateRej
message
egressAggregatePreference (1-10)
ingressAggregatePreference (1-10)
notify
options
7 257
CLI Reference Guide

Profiles
SIP CAC Profile

otherRequests
qoe
asr
asrCriticalLimit (0-70)
defaultQosAsr (0-100)
majorQosAsrLimit (0-90)
clu
cluCriticalLimit (80-100)
minTimeToProceed (60-3600)
pgrd
defaultPgrdFactor (50-10000)
pgrdCriticalLimit (50-10000)
scru
scruCriticalLimit (80-100)
refer
response
7 258

CLI Reference Guide

SIP CAC Profile
Profiles
subscribe
Command Parameters
TABLE 7 55 SIP CAC Profile Parameters
Parameter
Length/
Range
Description
sipCacProfile
1-23
The name of SIP Call Admission Control (CAC) profile.
Mandatory Parameters:
bandwidthLimit
0Maximum bandwidth (in Kbps) a peer can utilize. (default is

2147483 unlimited)
647
bandwidthLimitThreshold
0-100
Bandwidth threshold as percentage. (default = 0).
callEgressAggregateEmer
gencyPreference
1-10
Emergency call preference within the aggregate policer at

Egress. (default = 10)
callEgressAggregatePref
erence
1-10
Call preference within the aggregate policer at Egress.

(default = 1)
callEgressBurstSize
1-500
Maximum call burst size for calls to a registered endpoint or

peer. (default = 1).
callEgressEmergencyPref
erence
N/A
Emergency call preference at Egress.
callEgressRate
1-500,
Maximum egress call rate in calls per time period. (default is
unlimited unlimited).
1-10
Time period (in seconds) over which the egress call rate
applies. (default = 1).
callIngressAggregateEme
rgencyPreference
1-10
Emergency call preference within the aggregate policer at

Ingress. (default = 10)
disabled (default)
enabled

7 259
CLI Reference Guide

Profiles
SIP CAC Profile
TABLE 7 55 SIP CAC Profile Parameters (Continued)

Length/
Range
Description
callIngressAggregatePre
ference
1-10
Call preference within the aggregate policer at Ingress.

(default = 1)
1-500
Maximum call burst size from a peer or registered endpoint.

(default = 1).
callIngressEmergencyPre
ference
N/A
Emergency call preference at Ingress.
callIngressRate
1-500,
Maximum call arrival rate from a peer or registered endpoint
unlimited per callIngressRatePeriod. (default is unlimited).
Parameter
disabled (default)
enabled
A value of 0 indicates that call rate policing is not

applicable.
1-10
Time period (in seconds) over which the

callIngressRate applies. (default = 1).
callLimit
0-30000, Maximum number of active calls to and from any registered

unlimited endpoint or peer (e.g. total number of ingress and egress
calls). (default is unlimited)
callLimitEgress
0-30000, Maximum number of outbound active calls. (default is

unlimited unlimited)
callLimitIngress
0-30000, Maximum number of inbound active calls. (default is

unlimited unlimited)
callLimitThreshold
0-100
Call Limit utilization notification threshold, as a percentage.

(default = 0).
emergencyOversubscripti
on
0-1000
Oversubscription of calls (as a percentage) allowed for

emergency calls. (default = 0).
onEgress
0-1000
Oversubscription of egress calls (as a percentage) allowed

for emergency calls. When the baseline limit is reached,
normal calls are stopped but emergency calls are allowed up
to this additional percentage. (default = 10).
onIngress
0-1000
Oversubscription of calls (as a percentage) allowed for

emergency calls. When the baseline limit is reached, normal
calls are stopped but emergency calls are allowed up to this
additional percentage. (default = 10).
state
N/A
Administrative state of this SIP CAC Profile.

disabled (default)
enabled
Optional Parameters:
aggregateMessage
N/A
Use this object to configure the Aggregate Message policer

settings listed below.
egressBurstSize Maximum Aggregate Message
egress burst size. (range: 1-10000 / default = 10)
egressRate Maximum Aggregate Message egress
rate. (range: 1-1000, unlimited / default is unlimited)
egressRatePeriod Aggregate Message egress rate
period in seconds. (range: 1-10 / default = 1)
7 260

CLI Reference Guide

SIP CAC Profile
Profiles

Parameter
Length/
Range
Description
aggregateMessage
(continued)
N/A
ingressBurstSize Maximum Aggregate Message

ingress burst size. (range: 1-10000 / default = 10)
ingressRate Maximum Aggregate Message ingress
ingressRatePeriod Aggregate Message ingress
rate period in seconds. (range: 1-10 / default = 1)
dblAggregateRej
N/A
Use this object to Dynamically Blacklist (DBL) an endpoint

based on the CAC policer reject rate using settings below.
ingressBurstSize Maximum DBL Aggregate Reject
ingress burst size.(range: 1-10000 / default = 1)
ingressRate Maximum DBL Aggregate Reject
ingress rate.(range: 1-1000, unlimited / default is
unlimited)
ingressRatePeriod DBL Aggregate Reject ingress
rate period in seconds.(range: 1-10 / default = 1)
message
N/A
Use this object to configure the MESSAGE message in a

SIP CAC profile using the settings below.
egressAggregatePreference MESSAGE
preference within egress aggregate policer. (range: 1-10 /
default = 1)
egressBurstSize Maximum MESSAGE egress burst
size. (range: 1-10000 / default = 1)
egressRate Maximum MESSAGE egress rate.
(range: 1-1000, unlimited / default is unlimited)
egressRatePeriod MESSAGE egress rate period in
seconds. (range: 1-10 / default = 1)
ingressAggregatePreference MESSAGE
preference within ingress aggregate policer. (range: 1-10 /
default = 1)
ingressBurstSize Maximum MESSAGE ingress
burst size. (range: 1-10000 / default = 1)
ingressRate Maximum MESSAGE ingress rate.
(range: 1-1000, unlimited / default is unlimited)
ingressRatePeriod MESSAGE ingress rate period
in seconds. (range: 1-10 / default = 1)
notify
N/A
Use this object to configure the NOTIFY message in a SIP

CAC profile.
(egress and ingress settings are same as message
parameter above)
options
N/A
Use this object to configure the OPTIONS message in a SIP

CAC profile.
parameter above)

7 261
CLI Reference Guide

Profiles
SIP CAC Profile

Parameter
Length/
Range
otherRequests
N/A
Description
Use this object to configure the OTHER REQUESTS
message in a SIP CAC profile using the settings below.
egressAggregatePreference OTHER REQUESTS
preference within egress aggregate policer. (range: 1-10 /
default = 1)
egressBurstSize Maximum OTHER REQUESTS
egress burst size. (range: 1-10000 / default = 5)
egressRate Maximum OTHER REQUESTS egress
egressRatePeriod OTHER REQUESTS egress rate
period in seconds. (range: 1-10 / default = 1)
ingressAggregatePreference OTHER
REQUESTS preference within ingress aggregate policer.
ingressBurstSize Maximum OTHER REQUESTS
ingress burst size. (range: 1-10000 / default = 5)
ingressRate Maximum OTHER REQUESTS ingress
ingressRatePeriod OTHER REQUESTS ingress
rate period in seconds. (range: 1-10 / default = 1)
qoe
N/A
Use this object to configure the Quality of Service-based

routing configuration. The following parameters are used to
measure signaling quality:
asr Answer Seizure Ratio measurement.
asrCriticalLimit The critical ASR limit below
which call admission stops. (range: 0-70% / default =
40)
defaultQosAsr Default ASR value to use when no
calls are made for a sampling period.
(range: 0-100% / default = 90)
majorQosAsrLimit The major ASR limit. When
breached, an INFO log is generated and trunk group
stats are incremented one value.
(range: 0-90% / default = 70)
clu Call Limit Utilization measurement.
cluCriticalLimit Critical CLU limit (as
percentage) below which the trunk group or peer is
marked out of service for egress calls.
(range: 80-100% / default = 80)
7 262

CLI Reference Guide

SIP CAC Profile
Profiles

Parameter
Length/
Range
qoe (continued)
N/A
minTimeToProceed Minimum time to wait (in

seconds) before call admission resumes after peer/trunk
group KPI falls below critical threshold.
(range: 0-3600 seconds / default = 60)
pgrd Post Gateway Ringing Delay measurement.
defaultPgrdFactor Default PGRD value when no
calls are made for a sampling period.
(range: 50-10000 milliseconds / default = 500)
pgrdCriticalLimit Critical PGRD limit above
which the trunk group is marked out of service, and not
chosen for routing. (range: 50-10000 milliseconds /
default = 2000)
scru Sustained Call Rate Utilization measurement.
scruCriticalLimit SCRU KPI critical limit (as
percentage) above which the trunk group/peer is not
chosen for routing. (range: 80-100% / default = 80)
refer
N/A
Use this object to configure the REFER message in a SIP

CAC profile.
parameter above)
response
N/A
Use this object to configure the REFER message in a SIP

CAC profile.
(egress and ingress settings are same as otherRequests
parameter above)
subscribe
N/A
Use this object to configure the SUBSCRIBE message in a

SIP CAC profile.
parameter above)
Description
Command Example
% set profiles sipCacProfile SIPCAC_TEST state enabled
callIngressRate 78 callIngressRatePeriod 4
callIngressBurstSize 342 callEgressRate 43
callEgressRatePeriod 3 callEgressBurstSize 45 callLimit
4567 emergencyOversubscription 24
% show profiles sipCacProfile SIPCAC_TEST
state
enabled;
callIngressRate
78;
4;
342;
callEgressRate
43;
3;

7 263
CLI Reference Guide

Profiles
SIP CAC Profile
callEgressBurstSize
45;
callLimit
4567;
emergencyOversubscription
7 264
24;

CLI Reference Guide

System Profile
Profiles
System Profile
The System profile supports the following profiles which are explained in the
subsequent sections:
"Coredump Profile" on page 7 265

"IP Policing Alarm Profile" on page 7 266
"Overload Profile" on page 7 273
Coredump Profile
The coredump profile feature specifies limits on the maximum number, sensitivity
level and total size of coredump files.
Command Syntax
% set profiles system coredumpProfile <profile_name>
coredumpCountLimit <1-10>
coredumpLevel <disable|normal|sensitive>
coredumpSpaceLimit <1-20GB>
Command Parameters
TABLE 7 56 Coredump Profile parameters
Parameter
Length/
Range
Description
coredumpProfile
1-23
Specifies the name of the Coredump profile.

The symbol # may be used in the profile name to denote that
any character following the # symbol is a comment.
coredumpCountLimit
1-10
Specifies the number of coredumps allowed on a hard disk per

process. (default = 3)
coredumpLevel
N/A
Use this object to specify the coredump sensitivity level:

disabled
normal (default)
sensitive
coredumpSpaceLimit
1-20
Coredump disk space limit per server (in Gigabytes).

(default = 6)

7 265
CLI Reference Guide

Profiles
System Profile
Command Example
% set profiles system coredumpProfile MyCoreDump#example
coredumpLevel sensitive coredumpCountLimit 10
coredumpSpaceLimit 8
% show profiles system coredumpProfile
coredumpProfile MyCoreDump {
coredumpLevel
sensitive;
coredumpSpaceLimit 8;
coredumpCountLimit 10;
}
IP Policing Alarm Profile

The IP Policing Alarm Profile specifies the parameters to determine when alarms
associated with IP policing are generated and cleared.
Command Syntax
Use following CLI syntax to configure an IP Policing Alarm Profile. Two default
profiles are provided:
defaultSystemMajor
defaultSystemMinor
% set profiles system ipPolicingAlarmProfile <profile_name>

aclClearDuration <0-65535 seconds>
aclClearThreshold <0-2147483647>
aclSetDuration <0-65535 seconds>
aclSetThreshold <0-2147483647>
aggregateClearDuration <0-65535 seconds>
aggregateClearThreshold <0-2147483647>
aggregateSetDuration <0-65535 seconds>
aggregateSetThreshold <0-2147483647>
arpClearDuration <0-65535 seconds>
arpClearThreshold <0-2147483647>
arpSetDuration <0-65535 seconds>
arpSetThreshold <0-2147483647>
badEthernetIpHeaderClearDuration <0-65535 seconds>
badEthernetIpHeaderClearThreshold <0-2147483647>
badEthernetIpHeaderSetDuration <0-65535 seconds>
7 266

CLI Reference Guide

System Profile
Profiles
badEthernetIpHeaderSetThreshold <0-2147483647>
discardRuleClearDuration <0-65535 seconds>
discardRuleClearThreshold <0-2147483647>
discardRuleSetDuration <0-65535 seconds>
discardRuleSetThreshold <0-2147483647>
index <#>
ipSecDecryptClearDuration <0-65535 seconds>
ipSecDecryptClearThreshold <0-2147483647>
ipSecDecryptSetDuration <0-65535 seconds>
ipSecDecryptSetThreshold <0-2147483647>
mediaClearDuration <0-65535 seconds>
mediaClearThreshold <0-2147483647>
mediaSetDuration <0-65535 seconds>
mediaSetThreshold <0-2147483647>
rogueMediaClearDuration <0-65535 seconds>
rogueMediaClearThreshold <0-2147483647>
rogueMediaSetDuration <0-65535 seconds>
rogueMediaSetThreshold <0-2147483647>
uFlowClearDuration <0-65535 seconds>
uFlowClearThreshold <0-2147483647
uFlowSetDuration <0-65535 seconds>
uFlowSetThreshold <0-2147483647>
Command Parameters
TABLE 7 57 IP Policing Alarm Profile Parameters
Parameter
Length/Range Description
1-23
IP Policing Alarm Profile name. Two default

profiles are available as starting point in creating
custom profiles:
defaultSystemMajor
defaultSystemMinor
aclClearDuration
0-65535
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. (default = 3).
aclClearThreshold
0-2147483647 Specifies the threshold for the access control list

policer discard rate (in pkts/sec) which may clear
an alarm. (default = 20).

7 267
CLI Reference Guide

Profiles
System Profile
TABLE 7 57 IP Policing Alarm Profile Parameters (Continued)

Parameter
aclSetDuration
0-65535
aclSetThreshold
0-2147483647 Specifies the threshold for the access control list

policer discard rate (in pkts/sec) which may set an
alarm. (default = 100).
aggregateClearDuration
0-65535
aggregateClearThreshold
0-2147483647 Specifies the threshold for the aggregate policer

discard rate (in pkts/sec) which may clear an
aggregateSetDuration
0-65535
aggregateSetThreshold
0-2147483647 Specifies the threshold for the aggregate policer

discard rate (in pkts/sec) which may set an alarm.
(default = 100).
arpClearDuration
0-65535
arpClearThreshold
0-2147483647 Specifies the threshold for the ARP policer discard

rate (in pkts/sec) which may clear an alarm.
(default = 20).
arpSetDuration
0-65535
arpSetThreshold
0-2147483647 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
badEthernetIpHeaderClearDu
ration
0-65535
badEthernetIpHeaderClearTh
reshold
0-2147483647 Specifies the threshold for the bad Ethernet IP

header policer discard rate (in pkts/sec) which
may clear an alarm. (default = 20).
badEthernetIpHeaderSetDura
tion
0-65535
badEthernetIpHeaderSetThre
shold
0-2147483647 Specifies the threshold for the bad ethernet IP

header policer discard rate (in pkts/sec) which
may set an alarm. (default = 100).
discardRuleClearDuration
0-65535
7 268
Duration (in seconds) that the access control list

above its set threshold before an alarm is set.
(default = 3).
Duration (in seconds) that the aggregate policer

discard rate (in pkts/sec) must be at or below its
clear threshold before an alarm is cleared. (default
= 3).
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. (default = 3).
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. (default = 3).
Duration (in seconds) that the ARP policer discard

rate (in pkts/sec) must be at or above its set
threshold before an alarm is set. (default = 3).
Duration (in seconds) that the bad Ethernet IP

at or below its clear threshold before an alarm is
Duration (in seconds) that the bad ethernet IP

at or above its set threshold before an alarm is set.
(default = 3).
Duration (in seconds) that the discard rule discard

rate (in pkts/sec) must be at or below its clear
threshold before an alarm is cleared. (default = 3).

CLI Reference Guide

System Profile
Profiles

Parameter
discardRuleClearThreshold
0-2147483647 Specifies the threshold for the discard rule discard

rate (in pkts/sec) which may clear an alarm.
(default = 10).
discardRuleSetDuration
0-65535
discardRuleSetThreshold
0-2147483647 Specifies the threshold for the discard rule discard

rate (in pkts/sec) which may set an alarm.
(default = 20).
index
N/A
Identifies the Policer Discard Rate profile.

(default = 1).
ipSecDecryptClearDuration
0-65535
Duration (in seconds) that the IPSEC decrypt

below its clear threshold before an alarm is
ipSecDecryptClearThreshold
0-2147483647 Specifies the threshold for the IPSEC decrypt

policer discard rate (in pkts/sec) which may clear
an alarm. (default = 20).
ipSecDecryptSetDuration
0-65535
ipSecDecryptSetThreshold
0-2147483647 Specifies the threshold for the IPSEC decrypt

policer discard rate (in pkts/sec) which may set an
mediaClearDuration
0-65535
mediaClearThreshold
0-2147483647 Specifies the threshold for the media policer

mediaSetDuration
0-65535
mediaSetThreshold
0-2147483647 Specifies the threshold for the media policer

(default = 100).
rogueMediaClearDuration
0-65535
rogueMediaClearThreshold
0-2147483647 Specifies the threshold for the rogue media policer

rogueMediaSetDuration
0-65535
Duration (in seconds) that the discard rule discard

rate (in pkts/sec) must be at or above its set
threshold before an alarm is set. (default = 3).
Duration (in seconds) that the IPSEC decrypt

above its set threshold before an alarm is set.
(default = 3).
Duration (in seconds) that the media policer

clear threshold before an alarm is cleared.
(default = 3).
Duration (in seconds) that the media policer

Duration (in seconds) that the rogue media policer

= 3).
Duration (in seconds) that the rogue media policer


7 269
CLI Reference Guide

Profiles
System Profile

Parameter
rogueMediaSetThreshold
0-2147483647 Specifies the threshold for the rogue media policer

(default = 100).
state
N/A
Administrative state of the profile. The possible

values are:
disabled
enabled (default)
uFlowClearDuration
0-65535
Duration (in seconds) that the micro flow policer

= 3).
uFlowClearThreshold
0-2147483647 Specifies the threshold for the micro flow policer

uFlowSetDuration
0-65535
uFlowSetThreshold
0-2147483647 Specifies the threshold for the micro flow policer

(default = 100).
Duration (in seconds) that the micro flow policer

Command Example
defaultSystemMajor
% show profiles system ipPolicingAlarmProfile
defaultSystemMajor
index
1;
state
enabled;
badEthernetIpHeaderSetThreshold
100;
badEthernetIpHeaderClearThreshold 20;
7 270
badEthernetIpHeaderSetDuration
3;
badEthernetIpHeaderClearDuration
3;
arpSetThreshold
100;
arpClearThreshold
20;
arpSetDuration
3;
arpClearDuration
3;
uFlowSetThreshold
100;
uFlowClearThreshold
20;
uFlowSetDuration
3;
uFlowClearDuration
3;
aclSetThreshold
100;

CLI Reference Guide

System Profile
Profiles
aclClearThreshold
20;
aclSetDuration
3;
aclClearDuration
3;
100;
20;
3;
3;
100;
20;
3;
3;
mediaSetThreshold
100;
mediaClearThreshold
20;
mediaSetDuration
3;
mediaClearDuration
3;
100;
20;
3;
3;
20;
10;
3;
3;
defaultSystemMinor
% show profiles system ipPolicingAlarmProfile
defaultSystemMinor
index
1;
state
enabled;
badEthernetIpHeaderSetThreshold
100;
badEthernetIpHeaderClearThreshold 20;
badEthernetIpHeaderSetDuration
3;
badEthernetIpHeaderClearDuration
3;
arpSetThreshold
100;
arpClearThreshold
20;
arpSetDuration
3;
arpClearDuration
3;
uFlowSetThreshold
20;
uFlowClearThreshold
10;

7 271
CLI Reference Guide

Profiles
7 272
System Profile
uFlowSetDuration
3;
uFlowClearDuration
3;
aclSetThreshold
100;
aclClearThreshold
20;
aclSetDuration
3;
aclClearDuration
3;
100;
20;
3;
3;
100;
20;
3;
3;
mediaSetThreshold
100;
mediaClearThreshold
20;
mediaSetDuration
3;
mediaClearDuration
3;
100;
20;
3;
3;
20;
10;
3;
3;

CLI Reference Guide

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 for any of the call processing related processes, the congestion
level is raised to a higher level and the overload control is applied to help alleviate
the congestion. The profile also specifies clear congestion thresholds and
durations. These values require that the overload conditions fall below their
configured clear threshold values for a specific duration in order to return to the
previous congestion level. These minimum clear durations prevent repeatedly
switching 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
The following default Overload Profiles are automatically created for system
congestion levels 1-3:
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 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 <profile_name>
clearDuration
cpu <0-65535 seconds>
memory <0-65535 seconds>
clearThreshold
cpu <0-100>
memory <0-100>
setDuration
cpu <0-65535 seconds>
memory <0-65535 seconds>
setThreshold
cpu <0-100>
7 273
CLI Reference Guide

Profiles
System Profile
memory <0-100>
staticMode
acceptPercentage <0-100>
Command Parameters
TABLE 7 58 Overload Profile Parameters
Parameter
Length/
Range Description
overloadProfile
1-23
Overload Profile name. Use the following default profiles to create

custom profiles:
defaultMC1
defaultMC2
defaultMC3
clearDuration
N/A
Use this parameter to specify CPU and memory Clear Duration for a
monitored resource.
cpu -Length of time (in seconds) that CPU utilization percentage
must be below its clear threshold before congestion level clears. A
value of zero clears the congestion level immediately.
(range: 0-65535 / default = 10)
memory Length of time (in seconds) that memory (or ICM)
utilization percentage must remain above its set threshold before
congestion level sets or clears. A value of 0 clears the congestion
level immediately. (range: 0-65535 / default = 10)
clearThreshold
N/A
Use this parameter to specify CPU and memory Clear Threshold for a
monitored resource.
cpu CPU utilization percentage threshold at which a congestion
level is set or cleared. The clear threshold must be less than or
equal to the set threshold. (range: 0-100 / default = 80)
memory Memory utilization percentage threshold at which a
congestion level is set or cleared. (range: 0-100 / default = 85)
setDuration
N/A
Use this parameter to specify CPU and memory Set Duration for a
monitored resource.
cpu Length of time (in seconds) that CPU utilization percentage is
above its set threshold before congestion level is set. (range: 065535 / default = 10). A value of zero sets the congestion level
immediately.
memory Length of time (in seconds) that memory (or ICM)
utilization percentage remains above its set threshold before
congestion level is set. (range: 0-65535 / default = 10). A value of
zero sets the congestion level immediately.
7 274

CLI Reference Guide

System Profile
Profiles
TABLE 7 58 Overload Profile Parameters (Continued)

Parameter
Length/
Range Description
setThreshold
N/A
Use this parameter to specify CPU and memory Set Threshold for a
monitored resource.
cpu CPU utilization percentage threshold at which the congestion
level is set. (range: 0-100 / default = 85. A value of 0 disables CPU
utilization as a congestion criterion.
memory Memory (or ICM) utilization percentage threshold at
which a congestion level is set or cleared. (range: 0-100 / default =
90. A value of 0 disables memory utilization as a congestion
criterion.
N/A
state
Administrative state of the Overload profile.

disabled (default) Set to disabled to change parameter
values. While disabled, congestion processing continues to use the
previous profile values.
enabled Set to enabled to allow this profile to be referenced by
a system congestion level whereby all parameter values are
validated.
staticMode
N/A
Use this object to define the call accept percentage rate.

acceptPercentage The rate (as percentage) to accept calls for
the specified congestion level. (range: 0-100 / default = 100). A
value of 0 rejects all calls. A value of 100 accepts all calls.
Command Example
% show profiles system overloadProfile Test123
state enabled;
setThreshold
{
cpu
85;
memory 90;
}
clearThreshold
{
cpu
80;
memory 85;
}
setDuration
{
cpu
10;
memory 10;

7 275
CLI Reference Guide

Profiles
System Profile
}
clearDuration
{
cpu
10;
memory 10;
}
staticMode
{
acceptPercentage 85;
}
7 276

CHAPTER 8
System
This chapter describes system level configuration operations, such as how to

configure and manage server, ports, interface groups, static routes and security
MIBs of the system object. Topics include:
"Admin" on page 8 2
"Congestion" on page 8 8
"DSP PAD Resources" on page 8 13
"Ethernet Port" on page 8 19
"Interval Statistics" on page 8 21
"IP Policing" on page 8 22
"Juniper SRC Server" on page 8 23
Logical Management IP Interface on page 8-26
"Media" on page 8 28
"Media Profile" on page 8 31
"Management IP Interface Group" on page 8 32
"Management Static Route" on page 8 40
"NTP Services Management" on page 8 42
"Policy Server" on page 8 45
"Security Management" on page 8 52
"Server Administration" on page 8 56
81
CLI Reference Guide

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, password rules and other parameters.
Command Syntax
Command syntax for the set and request commands is shown below.
% set system admin <SYSTEM NAME>
auditLogState <disabled|enabled>
cliIdleTimeout <0-120 minutes>
cliSetWarningSupport <disabled|enabled>
contact <contact_info>
externalAuthenticationEnabled <false|true>
localAuthenticationEnabled <false|true>
location <location_info>
managementIpVersion <ipv4|ipv6>
passwordRules
maximumRepeatingCharsCount <#>
minimumLength <#>
minimumNumberOfDigits <#>
minimumNumberOfLowercaseChars <#>
minimumNumberOfOtherChars <#>
minimumNumberOfUppercaseChars <#>
passwordHistoryDepth <#>
standbyServerState <disabled|enabled>
utilMonitorStatsInterval <#>
utilMonitorStatsNumOfPastInterval <#>
% request system admin
identify
loadConfig
allowOldVersion <no|yes>
82

CLI Reference Guide

Admin
System
filename
removeSavedConfig
fileName <filename>
restart
revertMode <forced|normal>
saveConfig
fileNameSuffix <suffix>
softReset
switchover
Command Parameters
Set Command Parameters
TABLE 8 1
System Admin Parameters (Set)
Parameter
Length/
Range
Description
admin
N/A
Use this object to specify system name.
auditLogState
N/A
Use this flag to specify the management audit log state.

disabled
enabled (default)
cliIdleTimeout
0-120
cliSetWarningSupport N/A
The CLI idle timeout duration in minutes. (default = 30). If CLI idle
timeout is set to 0, the timeout value is infinity.
When this flag is enabled, warning prompts are configured for the
set command.
disabled
enabled (default)
contact
N/A
externalAuthenticati N/A
onEnabled
Use parameter to specify system contact information. (default is

Unknown)
The confd CLI user information stored on remote RADIUS server
is available for authentication.
false (default)
true
localAuthenticationE N/A
nabled
The confd CLI user information stored locally is available for

authentication.
false
true (default)
location
N/A
Specifies the physical location of the system.

83
CLI Reference Guide

System
TABLE 8 1
Admin
System Admin Parameters (Set) (Continued)
Parameter
Length/
Range
managementIpVersion
N/A
Description
Use this parameter to identify the management IP version for
SBC 5x00 to use when communicating to EMA/CLI/EMS, either
IPv4 or IPv6.
Ipv4 Supports 32-bit IP address in dotted decimal form (for
example 128.127.50.224).
Ipv6 Supports eight 16-bit IP address in hexadecimal values
separated by colons (for example
1280:1276:3350:2224:2222:3333:8888:1245).
WARNING: Changing the management IP version will
cause the SBC application to restart (in HA mode, both
CEs are affected), thus any active calls may be
terminated. Only perform this action during a maintenance
window or period of low activity.
A warning message similar to below will display:
Changing the management IP version will cause
the system to restart. All future CLI,
netconf, and SNMP sessions must connect using
IPV6. Be sure that the management ports can
be accessed using an IPV6 address. Do you
wish to continue?
passwordRules
N/A
The rules implementing confd user password policy.

maximumRepeatingCharsCount -Maximum number of
consecutive repeating characters in the password.
minimumLength -Minimum number of characters that
should be present in the password. (range: 8-24 / default = 8)
minimumNumberOfDigits -Minimum number of digits that
should be present in the password. (range: 0-16 / default = 1)
minimumNumberOfLowercaseChars -Minimum number of
lower case characters that should be present in the password.
minimumNumberOfOtherChars -Minimum number of nonalpha-numeric characters that should be present in the
password. (range: 0-16 / default = 1)
minimumNumberOfUppercaseChars -Minimum number of
upper case characters that should be present in the password.
passwordHistoryDepth -The number of latest passwords
that should be prevented from re-use.
standbyServerState
N/A
Use this flag to manually enable or disable standby server if the

active server fails.
disabled
enabled (default)
84

CLI Reference Guide

Admin
TABLE 8 1
System
System Admin Parameters (Set) (Continued)

Length/
Range
Parameter
Description
utilMonitorStatsInte 5-60
rval
Specifies time interval for system resource monitoring statistics.

This parameter defines the range of timer interval in minutes
used by configuration management for measuring the statistics of
certain resources. (default = 15).
utilMonitorStatsNumO 1-12
fPastInterval
The number of past intervals that can be configured for retrieving

the statistics data. (default = 4).
Request Command Parameters

TABLE 8 2
System Admin Parameters (Request)
Parameter
Length
/Range Description
commitSoftwareUpgrade N/A
identify
0-255
Commits software upgrade.

Turn on/off the locator LED of the specified server for the amount
of time set with the duration sub-parameter below.
duration The duration (in seconds) to illuminate the locator
LED of specified server. The LED illuminates for the specified
number of seconds and then extinguishes. A duration of 0
turns off the locator LED and a duration of 255 turns on the
locator LED indefinitely. If the duration is not specified, 15
seconds is set as the default value.
loadConfig
N/A
Load saved configuration and restart the system without

rebooting the servers.
allowOldVersion This option is only intended for use to
override checks for older releases which do not identify their
version. In this case, the follow error results; following the
instructions given:
There is no version identifier on the saved file. Use the
allowOldVersion parameter only if you are sure the version of
the saved configuration file is compatible with the running
software version. (see note below this table).
no
yes
filename Specify the configuration to be loaded.
NOTE: In a redundant system, using loadConfig restarts
both CE's.
removeSavedConfig
N/A
Remove the saved configuration from the system.

fileName Specify filename of configuration to remove from
the system.
restart
N/A
Restart system (all CEs).

85
CLI Reference Guide

System
TABLE 8 2
Admin
System Admin Parameters (Request) (Continued)

Length
/Range Description
Parameter
revertSoftwareUpgrade N/A
Use this control to revert the last live software upgrade using one
of the following selectable revert modes:
revertMode
forced
normal
N/A
saveConfig
Save the current configuration.

fileNameSuffix Use this parameter to specify the
filename suffix to use when saving the configuration.
softReset
N/A
Restart the applications on the system without rebooting the

server(s).
switchover
N/A
Perform a switchover of the management applications and restart

all applications on currently active server.
NOTE
If this error is returned: "reason Configuration file version not

compatible with current software version.
matrixFileNotAvailable", there is no lswuMatrixSBX5000.bin/
lswuMatrixSBX5000.txt file in the /opt/sonus directory. The user must
restore these files, which are contained in the release package of the
currently running software with the name pattern of "sbcV0X.YY.ZZRQQQ.x86_64.tar.gz". Unzip and untar the current release's
tar.gz file in that directory, return to the CLI and perform the command
again.
Command Examples
To display system administrative information:
% show system admin
admin SBCa {
location
Richardson;
contact
LabMgr;
cliIdleTimeout
0;
managementIpVersion ipv4;
auditLogState
enabled;
passwordRules {
minimumLength
8;
minimumNumberOfUppercaseChars 1;
minimumNumberOfLowercaseChars 1;
86
minimumNumberOfDigits
1;
minimumNumberOfOtherChars
1;

CLI Reference Guide

Admin
System
passwordHistoryDepth
4;
maximumRepeatingCharsCount
3;
}
}
To turn on locator LED for 60 seconds:
% request system admin FUBBCANARY identify duration 60
result success
reason Identifying server(s)...
[ok][2012-12-28 08:46:19]

87
CLI Reference Guide

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 load, 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)
88

CLI Reference Guide

Congestion
System
control the call burst handling capability. The policer fill rate controls the sustained
rate (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 4 16.
Command Syntax
% set system congestion
adaptive
MCLevel (mc0|mc1|mc2|mc3>
levelMC1
overloadProfileName <defaultMC1>
levelMC2
levelMC3
mode <adaptive|static>
policer
burstSize <5-100>
preference
call <0-3>
emergencyCall <0-3>
initialSipRegister <0-3>

89
CLI Reference Guide

System
Congestion
Command Parameters
TABLE 8 3
System Congestion Parameters
Parameter
Length
/Range Description
adaptive
N/A
Adaptive overload configuration.

MCLevel Sets the system machine congestion level at which the system
adaptive algorithm activates:
mc0 Use this level during LWSU to disable the system adaptive
algorithm.
mc1 Adaptive congestion control is activated at system congestion
level mc1.
level mc2.
level mc3.
levelMC1
N/A
The operational state of machine congestion level 1, or MC1.

mode The Maintenance mode of MC1.
inService (default) The most recently assigned Overload Profile is
validated and activated.
outOfService Congestion control processing for machine level 1 is
suspended. A new Overload Profile can be assigned.
overloadProfileName The Overload Profile name of MC1.
defaultMC1 The name of the Overload Profile assigned to Machine
Congestion Level 1 (MC1).
levelMC2
N/A

8 10

CLI Reference Guide

Congestion
TABLE 8 3
System
System Congestion Parameters (Continued)
Parameter
Length
/Range Description
levelMC3
N/A

N/A
mode
The system overload control mode.

adaptive (default) Adaptive overload control mechanism is applied.
static Static overload control mechanism is applied.
policer
N/A
The system congestion Call Rate Policer configuration.

burstSize Maximum number of credits in the system congestion
policer bucket. This controls call burst handling capability during system
congestion. 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. (range: 5-100 / default = 50
calls).
preference Use this control to assign a preference value (0 to 3) to the
call types below, where 0 is the highest and 3 is the lowest preference
value.
call Preference value applied during normal call admission
(default = 1).
emergencyCall Preference value that is applied during emergency
call admission (default = 0).
initialSipRegister Preference value that is applied during initial
SIP registration admission (default = 2).
displaylevel
1-64
Displays the different levels of output information in show commands.
Command Example
To display congestion configuration information:
% show system congestion
levelMC1 {
mode
outOfService;
overloadProfileName defaultMC1;
}
8 11
CLI Reference Guide

System
Congestion
levelMC2 {
mode
outOfService;
}
levelMC3 {
mode
outOfService;
}
mode adaptive;
adaptive {
MCLevel mc2;
}
policer {
burstSize 50;
}
8 12

CLI Reference Guide

DSP PAD Resources
System
DSP PAD Resources
This object allows you to specify the characteristics of the DSP Packet Assembler/
Disassembler (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:
g711a
g711u
g.723.1
g726
g729
t38
ilbc
amr
evrc
g722
g7222
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.

8 13
CLI Reference Guide

System
DSP PAD Resources
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:
Good
Acceptable
Poor
Unacceptable
Whenever the playout buffer has no data to play due to packet loss or excessive
jitter, the SBC 5x00 tracks 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 8 4
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 THRESHOLD1
Acceptable
Greater than THRESHOLD1 and less than THRESHOLD2
Poor
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).
8 14

CLI Reference Guide

DSP PAD Resources
System
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
Command Syntax
% set system dspPad
audioTxDuring2833 <disabled|enabled>
comfortEnergy <-90dBm to -35dBm>
jitterEvalPeriod <period in milliseconds>
jitterMinOccThsh <threshold in milliseconds>
playoutTimeseriesPeriod <period in milliseconds>
playoutTimeseriesThreshold0 <threshold in milliseconds>
rtpDtmfRelay <#>
sidHangoverTime <time in milliseconds>
sidMaxNoiseFloor <-62dBm to -24dBm>
sidMaxTime <time in milliseconds>
sidMinNoiseFloor <-62dBm to -24dBm>
sidMinTime <time in milliseconds>
toneThreshold <percentage>
toneThresholdState <disabled|enabled>
universalCompressionThreshold <percentage>
universalCompressionThresholdState <disabled|enabled>

8 15
CLI Reference Guide

System
DSP PAD Resources
Command Parameters
TABLE 8 5
DSP Pad Resources Parameters
Parameter
Length/
Range
Description
Use this flag to specify the Audio Transmit state during RFC2833.
audioTxDuring2833
disabled
enabled (default)
comfortEnergy
-90 to -35
(dBm0)
The initial estimate used for generating comfort noise when the
CODEC in the Packet Service Profile is G.711 or G.711SS. For
G.711, when no modem has been detected, this represents the
level of comfort noise to fill in the audio when packet loss occurs.
This plays until the first packet is received. Whenever there is a
drop in packets (packet loss or silence periods), the G.711SS
represents the level of comfort noise when no SID is received.
(default = 56 [which represents -56 dBm0]).
jitterEvalPeriod
10-300000 Time period (in milliseconds) to decide when to periodically

evaluate playout occupancy. This parameter determines the rate
at which the jitter buffer is adapted.
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.
(default = 1000).
jitterMinOccThsh
2-200
The minimum jitter buffer occupancy threshold (in milliseconds)

below which the playout time advances 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, 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.
(default = 20). Setting this number to 200 disables jitter buffer
adaptation.
playoutTimeseriesP 10000240000
eriod
8 16
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.
(default = 20000 [or 20 seconds]).

CLI Reference Guide

DSP PAD Resources
TABLE 8 5
System
DSP Pad Resources Parameters (Continued)
Parameter
Length/
Range
playoutTimeseriesT N/A
hreshold0
Description
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 value is
0, or 0 percent of the playoutTimeseriesPeriod.
This parameter is applicable for all channel instances.
hreshold1

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 value is 200 (0.2 seconds, or 1 percent of the
playoutTimeseriesPeriod).
hreshold2

Loss durations greater than Threshold1 and less than
Threshold2 are considered Poor. Loss durations greater than
Threshold2 are considered Unacceptable. The default value is
600 (0.6 seconds, or 3 percent of the
playoutTimeseriesPeriod).
rtpDtmfRelay
0-127
This integer specifies the RTP payload type to use for DTMF
Relay during compressed calls. When running RFC 2833 with
H.323 or SIP signaling, H.323 disallows 0-95. (default = 100).
sidHangoverTime
80-2560
This integer specifies the minimum time (in milliseconds), after

voice is detected inactive before sending a SID packet.
(default = 300).
sidMaxNoiseFloor
24-62
This (positive) integer specifies the maximum noise level; above

this noise level is considered to be speech (in dBm0s).
sidMaxTime
50-300000 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). (default = 2000, or 2 seconds).
sidMinNoiseFloor
24-62
sidMinTime
50-300000 This integer specifies the minimum time between SID packets, in
milliseconds. This ensures that SID packets are not sent too
frequently when the background noise is changing, but instead
some minimum amount of compression still occurs.
(default = 200).
This (positive) integer specifies the minimum noise level; below

this noise level is considered to be silence (in dBm0s).

8 17
CLI Reference Guide

System
TABLE 8 5
DSP PAD Resources
DSP Pad Resources Parameters (Continued)
Parameter
Length/
Range
toneThreshold
1-100
toneThresholdState N/A
Description
The percentage of threshold crossing value for tone resources.
(default = 90).
The state of the tone threshold event.
disabled
enabled (default)
universalCompressi 1-100
onThreshold
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. (default = 90).
universalCompressi N/A
onThresholdState
When this flag is enabled, a trap is generated when universal

compression resources are reduced beyond the configurable
universalCompressionThreshold value.
disabled
enabled (default)
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;
universalCompressionThreshold
90;
universalCompressionThresholdState enabled;
8 18
playoutTimeseriesPeriod
20000;
0;
200;
600;
toneThreshold
90;
toneThresholdState
enabled;
audioTxDuring2833
enabled;

CLI Reference Guide

Ethernet Port
System
Ethernet Port
Use this object to configure the management, packet and field service ethernet
ports.
Command Syntax
% set system ethernetPort mgmtAdmin <system_name>
<mgt0|mgt1> portIndex <index #>
% set system ethernetPort packetAdmin <system_name>
<pkt0|pkt1|pkt2|pkt3> portIndex <index #>
Command Parameters
TABLE 8 6
Ethernet Port Parameters
Parameter
Length/
Range
Description
mgmtAdmin
N/A
Use this object to configure management ports.

<system_name> The host name of the server.
<mgt0|mgt1> The management port.
portIndex The internal port index.
pktAdmin
N/A
Use this object to configure packet ports.

<system_name> The host name of the server.
<pkt0|pkt1|pkt2|pkt3> The packet port.
portIndex The internal port index.
Command Example
To display ethernet port configuration:
% show system ethernetPort
packetAdmin merc pkt0 {
portIndex 2;
}
portIndex 3;
}

8 19
CLI Reference Guide

System
Ethernet Port
portIndex 4;
}
portIndex 5;
}
mgmtAdmin merc mgt0 {
portIndex
0;
}
mgmtAdmin merc mgt1 {
portIndex
8 20
1;}

CLI Reference Guide

Interval Statistics
System
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 to store and the timer interval are configurable parameters.
Command Syntax
% set system intervalStatistics
numOfPastIntervals <1-12>
timeInterval <5-60 minutes>
Command Parameters
TABLE 8 7
Interval Statistics Parameters
Parameter
Length/
Range
numOfPastIntervals
1-12
The maximum number of past intervals that can be configured for

retrieving the statistics data. (default = 4).
timeInterval
5-60
The time interval (in minutes) used by the configuration

management to measure the interval statistics. (default = 15).
Description
Command Example
To display interval statistics configuration:
% show system intervalStatistics
timeInterval
15;
numOfPastIntervals 4;

8 21
CLI Reference Guide

System
IP Policing
IP Policing
Use this feature to reset designated offender lists as described below.
Command Syntax
% request system ipPolicing resetOffendersList name
aclOffendersList|aggregateOffendersList|
arpOffendersList|badEtherIpHdrOffendersList|
discardRuleOffendersList|ipSecDecryptOffendersList|
mediaOffendersList|rogueMediaOffendersList|
uFlowOffendersList
Command Parameters
TABLE 8 8
System IP Policing Parameters
Parameter
Length/
Range Description
ipPolicing
N/A
The IP Monitoring MIB module name.
resetOffendersList
N/A
Use this object to reset the data in the selected offenders

list.
name The offenders list name:
aclOffendersList
arpOffendersList
mediaOffendersList
uFlowOffendersList
Command Example
% request system ipPolicing resetOffendersList name
aclOffendersList
result success
reason
[ok][2012-12-27 09:39:47]
8 22

CLI Reference Guide

Juniper SRC Server
System
Juniper SRC Server
The SBC 5x00 is integrated with Juniper Session Resource Controller (JSRC)
using SOAP interface, and performs enhanced call processing such as bandwidth
reservation and Gateway client process creation.
For example, when a call comes in, SBC 5x00 acting as a Gateway client contacts
the SRC and reserves bandwidth for the session. Once the call completes, the
bandwidth reservation is released. Currently, each business partner can have
three users (user1, user 2, user3). Each of these users has a 6M (6000000) link to
the DSLAM.
The CLI syntax to configure the remote server and SBC 5x00 global configuration
is detailed in this section.
Command Syntax
// Mandatory parameters for jsrcServer
% set system jsrcServer
remoteServer <server_name>
srcPassword <password>
srcServerAddress <IPv4 or IPv6 address>
srcUsername <user_name>
// Non-mandatory parameters for jsrcServer
% set system jsrcServer
globalConfig
DNSuffix <DN_suffix>
maxNumberOfFailuresAllowed (0-10)
numberOfRetries (0-10)
organizationalUnit <name>
reservationFailurePolicy <continue|reject>
retailerName <name>
routerPolicyEnable <disabled|enabled>
srcBandwidithReservationEnabled <disabled|enabled>
srcReconnectPollTimeout <0-3600>
srcSessionTimeout <1-2147483647>

8 23
CLI Reference Guide

System
Juniper SRC Server
Command Parameters
TABLE 8 9
JSRC Server Parameters
Parameter
Length/
Range Description
jsrcServer
1-23
The JSRC server name.
globalConfig
N/A
This defines global configuration applicable to all the JSRC

servers.
DNSuffix DN Suffix. (default is o=Users,o=UMC)
maxNumberOfFailuresAllowed The maximum number of
failures that can occur before disabling the SRC server.
numberOfRetries The number of times to retry a
subscription request. (range: 0-10 / default = 2)
organizationalUnit Organizational unit name. (1-23
characters / default is SBC)
reservationFailurePolicy The action to take on
reservation failures.
continue
reject (default)
retailerName Retailer name. (1-23 characters / default is
Sonusnet)
routerPolicyEnable Use this flag to enable/disable router
policy.
disabled (default)
enabled
srcBandwidithReservationEnabled Enable flag to
reserve bandwidth for through the JSRC server.
disabled (default)
enabled
srcReconnectPollTimeout The timeout (in seconds)
when attempting to reconnect to failed servers. Specify 0 to
disable polling. (range: 0-3600 / default = 10)
srcSessionTimeout The timeout (in seconds) after which
the SRC server reclaims the bandwidth for the subscription.
(range: 1-2147483647 / default = 3600)
remoteServer
N/A
JSRC remote server configuration.

<JSRC server identifier> Specify the server name.
srcPassword The SOAP gateway password.
srcServerAddress The IPv4 or IPv6 IP address of the
JSRC server as an IPv4 address in dot notation, or an IPv6
address in hex-colon notation.
srcUsername The SOAP gateway user name.
state Administrative state of the JSRC server.
disabled (default)
enabled
8 24

CLI Reference Guide

Juniper SRC Server
System
Command Example
This example configures and enables remote server named JSRC_1 with
password of Password1, IP address of 10.11.12.13, username of srcAdmin.
Additionally, the following global SRC configuration parameters are set. For the
remaining parameters, default values are accepted.
maxNumberOfFailuresAllowed = 4
reservationFailurePolicy = reject
srcBandwidthReservationEnabled = enabled
% set system jsrcServer remoteServer JSRC_1 srcPassword

Password1 srcServerAddress 10.11.12.13 srcUsername
srcAdmin state enabled
% set system jsrcServer globalConfig
maxNumberOfFailuresAllowed 4 reservationFailurePolicy
reject srcBandwidithReservationEnabled enabled4
% show system jsrcServer
globalConfig {
srcBandwidithReservationEnabled enabled;
maxNumberOfFailuresAllowed
4;
reservationFailurePolicy
reject;
}
remoteServer JSRC_1 {
state
enabled;
srcServerAddress 10.11.12.13;
srcUsername
srcAdmin;
srcPassword
$3$Us0Iau8Nh2WAMtFejyHaMw==;

8 25
CLI Reference Guide

System
Logical Management IP Interface
The Logical Management IP Interface is a virtual management IP interface

configurable using CLI syntax described in this section.
Command Syntax
set system logicalMgmtIpInterface <intfc_name>
mgmtIpInterfaceGroupName <name>
Command Parameters
TABLE 8 10 Interval Statistics Parameters
Parameter
Length/
Range Description
N/A
The logical management IP interface name.
ipAddress
N/A
The logical IP address of the interface. The following IP

IPv4 Uses dotted decimal format (for example
128.127.50.224).
IPv6 Uses hexadecimal/colon format (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
mgmtIpInterfaceGroupName
N/A
The name of the management IP interface group used by

this logical IP interface.
state
N/A
Administrative state of the logical management IP interface.

disabled (default) 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
8 26
1-64
Displays the different levels of output information in show

commands.

CLI Reference Guide

System
Command Example
To display the logical management IP interface configuration:
% show system logicalMgmtIpInterface LogMgmt
mgmtIpInterfaceGroupName mgmtGroup;
ipAddress
3FFE:1900:4545:3:200:F8FF:FE21:67CF;
state
disabled;
To display the logical management IP interface configuration for two subnets:

% show system logicalMgmtIpInterface
logicalMgmtIpInterface AGMGM {
mgmtIpInterfaceGroupName mgmtGroup1;
ipAddress
10.54.67.50;
state
enabled;
}
logicalMgmtIpInterface HAMGM {
ipAddress
10.54.66.65;
state
enabled;
}
NOTE
When configuring the management interfaces on two subnets, a logical

management IP interface is needed for each subnet.

8 27
CLI Reference Guide

System
Media
Media
SBC 5x00 supports the following Real Time Control Protocol (RTCP) modes:
RTCP Relay for pass-through calls RTCP is relayed between the two
end-users. 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 and reports packet RTCP for output to CDRs.
SBC 5x00 also supports RTP/RTCP inactivity detection. The media object allows
you to configure the following settings:
Peer inactivity timeout Configure media peer inactivity timeout value.

Media port range Configure base UDP port and maximum UDP port.
Media RTCP control Configure the sender report interval.
Command Syntax
% set system media
mediaPeerInactivity
inactivityTimeout <20-1260, in multiples of 10>
mediaPortRange
baseUdpPort <5000-65534>
maxUdpPort <5000-65534>
mediaRtcpControl
senderReportInterval <5-120>
8 28

CLI Reference Guide

Media
System
Command Parameters
TABLE 8 11 Media Parameters
Parameter
Length/
Range
Description
mediaPeerInactivity
N/A
Use this control to set media peer inactivity timeout value.

inactivityTimeout Set RTP/RTCP inactivity timeout
value (in seconds) to guard against loss of media
connection.The timer is restarted whenever an RTP or RTCP
packet is received from the peer.
When both RTP and RTCP are enabled, timeout will only occur
if both packet types remain undetected for the configured
inactivityTimeout duration. If RTCP is not enabled, then
only the absence of RTP causes the timer to expire. Specify
timeout value in multiples of 10. (range: 20-1260 / default = 60)
NOTE: When using this feature, you must also set the
"peerAbsenceAction" flag from Packet Service Profile.
mediaPortRange
N/A
Use this control to set the base UDP port number and range for
RTP/RTCP media.
NOTE: Ensure that SIP Signaling Port portNumber value
(see Table 4 25) is outside the configured
mediaPortRange when transportProtocolsAllowed =
sip-udp. When mediaPortRange is configured, user is
prompted to continue with the configuration.
baseUdpPort Base UDP port number for RTP/RTCP media
(inclusive). (range: 5000-65534 / default = 5000).
maxUdpPort Maximum UDP port number for RTP/RTCP
media (inclusive). (range: 5000-65534 / default = 65148).
mediaRtcpControl
5-120
Use this control to set the RTCP Sender Report (SR) interval.
senderReportInterval Use this value as the initial
interval (in seconds) for NP to generate sender/receiver report
when RTCP termination is enabled in the packet service
profile. (default = 5).
Command Example
The following example sets inactivityTimeout value to 90, the
baseUdpPort to 6000, the maxUdpPort number to 65100 and the
senderReportInterval to 6 seconds, and also sets peerAbsenceAction
parameter from packetServiceProfile object to send a trap if inactivity is detected.
% set system media mediaPeerInactivity inactivityTimeout 90
% set system media mediaPortRange baseUdpPort 6000
maxUdpPort 65100
% set system media mediaRtcpControl senderReportInterval 6

8 29
CLI Reference Guide

System
Media
% set profiles media packetServiceProfile DEFAULT

peerAbsenceAction peerAbsenceTrap
% show system media
mediaPortRange {
baseUdpPort 6000;
maxUdpPort
65100;
}
mediaPeerInactivity {
inactivityTimeout 90;
}
mediaRtcpControl {
senderReportInterval 6;
}
8 30

CLI Reference Guide

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:
compression
tone
Command Syntax
% set system mediaProfile
compression <0-100>
tone <0-100>
Command Parameters
TABLE 8 12 Media Profile Parameters
Parameter
Length/
Range
Description
compression
0 to 100
Specifies the percentage (of DSP Cores) for capability Compression.
tone
0 to 100
Specifies the percentage (of DSP Cores) for capability Tone.
displaylevel
1-64
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 compression
compression 50;
[ok][2012-06-29 05:18:30]
% show system mediaProfile tone
tone 50;
[ok][2012-06-29 05:20:14]

8 31
CLI Reference Guide

System
Management IP Interface Group
This object allows you to configure a group of management IP interfaces for the
default address context. A management IP interface must contain at least one IP
address to be considered a valid interface.
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 <mgmtIpIntfceGrp_name>
mgmtIpInterface <IP_Intfce_name>
ceName <ceName>
ipAddressV4 <IPv4_address>
portName <mgt0|mgt1|mgt2|mgt3>
prefixV4 <prefix>
prefixV6 <prefix>
NOTE
For management interface groups (and interfaces), the default address

context is implied and therefore the address context is not specified.
% show system mgmtIpInterfaceGroup <mgmtIpIntfceGrp_name>
mgmtIpInterface <IP_Intfce_name>
ceName <system_name>
portName <portName>
prefixV4 <prefix>
prefixV6 <prefix>
8 32

CLI Reference Guide

System
% delete system mgmtIpInterfaceGroup <mgmtIpIntfceGrp_name>

mgmtIpInterface <mgmt_interface_#>
ipAddressV4
ipAddressV6
prefixV4
prefixV6
The above delete command allows the deletion of an IPv4 address and prefix
on the management interface only if:
the state is set to disabled, and

an IPv6 address exists.
NOTE
The management IP interface must contain at least one IP address to be

considered valid.

8 33
CLI Reference Guide

System
Command Parameters
TABLE 8 13 Management IP Interface Group Parameters
Parameter
Length/
Range Description
mgmtIpInterfaceGroup 1-23
IP Interface Group name.
mgmtIpInterface
1-23
Management IP interface name.
ceName
1-255
Name of the computing element that hosts the port used by

management IP interface.
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).
ipAddressV4
0-32
IPv4 address of the interface.

Length is in the range of 0 to 32. The 32-bit IP address in dotted
decimal form (for example 128.127.50.224).
ipAddressV6
0-128
IPv6 address of the interface.

Length is 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).
NOTE: Duplicate Address Detection procedures are
performed on interfaces configured with IPv6 addresses.
If a duplicate address is found in the network, a warning
message is output to Linux logs at /var/log/syslog and
/var/log/messages.
Example message:
Nov 12 08:52:35 SBC-1 kernel: [854194.740638] mgt1:
IPv6 duplicate address fc00::100:0:0:100:1 detected
portName
N/A
Port used by management IP interface (either two or four mgmt

ports are available depending upon if SBC is configured for HA).
mgt0
mgt1
mgt2
mgt3
prefixV4
0-32
IPv4 subnet prefix of management interface.
prefixV6
0-128
IPv6 subnet prefix of management interface.
state
N/A
Administrative state of the management network interface.

disabled (default) The management IP interface is inactive
and does not respond to a ping.
enabled The management IP interface is active and
responds to a ping (Ethernet cable must be connected).
8 34

CLI Reference Guide

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
8 35
CLI Reference Guide

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;
}
}
8 36

CLI Reference Guide

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
10.54.66.1
mgmtGroup
mgmtIntf1
10
0.0.0.0
10.54.66.1
mgmtGroup
mgmtIntf3
10
0.0.0.0
10.54.67.1
mgmtGroup1
mgmtIntf2
10

8 37
CLI Reference Guide

System
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
8 38

CLI Reference Guide

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. A two-subnet configuration
is a more robust network design.

8 39
CLI Reference Guide

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 will be used.
Command Syntax
% set system mgmtStaticRoute <destinationIpAddress>
<prefix>
<nextHopIPaddress>
mgmtGroup <mgmtIntf1|mgmtIntf2|mgmtIntf3|mgmtIntf4>
preference <1-99>
% show system mgmtStaticRoute <destinationIpAddress>
<prefix>
<nextHopIPaddress>
mgmtGroup <mgmtIntf1|mgmtIntf2|mgmtIntf3|mgmtIntf4>
preference <1-99>
% delete system mgmtStaticRoute
Command Parameters
TABLE 8 14 Management Static Route Parameters
Parameter
Length/
Range Description
<destinationIpAddress> N/A
The destination IP address (IPv4 or IPv6). This may be an

Ethernet switch address, but must never be a symbolic IP
address.
<prefix>
N/A
The IP prefix of this static route entry.
<nextHopIPaddress>
N/A
The IPv4 or IPv6 address of the next system enroute to the

destination. Default value is 0.0.0.0.
8 40

CLI Reference Guide

System
TABLE 8 14 Management Static Route Parameters (Continued)

Parameter
Length/
Range Description
mgmtGroup
N/A
Specifies the name of the management IP interface.
1-99
preference
mgmtIntf1
mgmtIntf2
mgmtIntf3
mgmtIntf4
Specifies the route preference, which is 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
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 an environment with two subnet management SBC 5x00 HAs, it is

mandatory to add static routes referencing the management interfaces
when creating a new management group.

8 41
CLI Reference Guide

System
NTP Services Management
Use this object to configure a Network Time Protocol (NTP) server supplying local
time to the SBC 5x00. The reference time delivered by NTP is the source of all
time stamps placed into the accounting records.
During the SBC 5x00 installation process, the NTP server and time zone
information is input to the Active server only. Once the Standby server starts, this
information is synced from the Active to Standby.
NOTE
The SBC 5x00 should receive an initial time synchronization from NTP
server before accepting calls.
Command Syntax
Use the following CLI syntax to configure NTP server.
% set system ntp
serverAdmin <IP_address>
maxPoll <10-17>
minPoll <4-17>
version <version3|version4>
timeZone <SYSTEM NAME>
zone <zone>
WARNING
Changing the time zone forces a restart of the SBC 5x00 application,
and thus cause a service outage for a few minutes. Sonus recommends
only changing the time zone during a system maintenance window.
NOTE
After the application is restarted, the rsyslog process must be manually

restarted as well (this will be automated in a future release). See SBC
3.1 Operations Guide for details.
8 42

CLI Reference Guide

System
Command Parameters
TABLE 8 15 NTP Services Management Parameters
Parameter
Length/
Range Description
serverAdmin N/A
<ip_address> The IP address of this NTP server.
maxPoll
10-17
Maximum number of times client polls the server. (default = 10).
minPoll
4-17
Minimum number of times the client polls the server. (default = 4).
state
N/A
NTP server state.

disabled (default) The state of the NTP server is disabled.
enabled The state of the NTP server is enabled.
version
N/A
NTP server version.

version3 (default)
version4
timeZone
N/A
<system_name> SBC 5x00 system name.

zone Specify the time zone where the node resides:
gmt
gmtMinus01-Azores
gmtMinus02-MidAtlantic
gmtMinus03-BuenosAires
gmtMinus04-Atlantic-Canada
gmtMinus0430-Caracas
gmtMinus05-Bogota
gmtMinus05-Eastern-US
gmtMinus05-Indiana
gmtMinus06-Central-US (default)
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

8 43
CLI Reference Guide

System
TABLE 8 15 NTP Services Management Parameters (Continued)

Parameter
Length/
Range Description
timeZone
N/A
(continued)
gmtPlus0530-Calcutta
gmtPlus06-Dhaka
gmtPlus07-Bangkok
gmtPlus08-HongKong
gmtPlus09-Tokyo
gmtPlus0930-Adelaide
gmtPlus10-Guam
gmtPlus11-Magadan
gmtPlus12-Fiji
gmtPlus12-Kwajalein
Command Example
The following example enables NTP server version 4 at IP address 10.35.45.55,
and sets time zone of SBC 5x00 system to Hawaii time.
% set system ntp serverAdmin 10.35.45.55 version version4
% set system ntp serverAdmin 10.35.45.55 state enabled
% set system ntp timeZone SBC_TEST zone gmtMinus10-Hawaii
% show system ntp
timeZone FUBBCANARY {
zone gmtMinus10-Hawaii;
}
serverAdmin 10.35.66.33 {
version version4;
minPoll 4;
maxPoll 10;
state
enabled;
8 44

CLI Reference Guide

Policy Server
System
Policy Server
This object allows you to configure up to 10 policy servers (one local server and
nine external policy servers). When an active server becomes congested, the
SBC 5x00 will first distribute overflow traffic to one of the active servers with
enough capacity, or to one of the standby servers that is not currently congested.
The SBC 5x00 can get policy services from one or more active servers in loadsharing (or round-robin) mode, and one or more active servers can be configured
in the standby mode.
Types of policy server configurations include:
"Global Configuration" on page 8 45 is applicable to all policy servers.

"Local Policy Server Configuration" on page 8 47 is applicable to local
(embedded) policy server.
"Remote Policy Server Configuration" on page 8 49 is applicable to remote
policy servers.
The SBC 5x00 administrator enables or disables the policy server. When a policy
server is enabled, it receives database queries from the SBC 5x00. You can
enable or disable the policy server only in the out-of-service mode.
Global Configuration
Command Syntax
% set system policyServer globalConfig
congestionControl <disabled|enabled>
mgmtInterfaceGroup <mgmtInterfaceGroup_name>
reconnectTimeout <# seconds>
switchOverMode <automatic|manual>

8 45
CLI Reference Guide

System
Policy Server
Command Parameters
TABLE 8 16 System Policy Server Global Configuration Parameters
Parameter
Length/
Range Description
congestionControl
N/A
When this parameter is enabled, the SBC 5x00 throttles the sending
or policy requests to either active or standby policy server. Options
are:
enabled
disabled
mgmtInterfaceGroup N/A
Specifies the Management Interface Group to be used for

communication with the policy server.
reconnectTimeout
N/A
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
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;
congestionControl enabled;
mgmtInterfaceGroup mgmtGroup;
To view the status of policy servers:
% show table system policyServer globalConfig
8 46

CLI Reference Guide

Policy Server
System
Local Policy Server Configuration

Command Syntax
% set system policyServer localServer <softswitch_name>
keepAliveTimer <1-60 seconds>
mode <active|alternate|outOfService|standby>
retries <0-32>
retryTimer <# milliseconds>
transactionTimer <50-60000 milliseconds>
Command Parameters
TABLE 8 17 Local Policy Server Configuration Parameters
Parameter
Length/
Range
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.
Must be 1-60, default is 5.
N/A
mode
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 policy servers fail and local policy
server is in standby mode, the standby local policy server is
used as active server until the external policy server becomes
active.
retries
0-32
Specifies the number of retries for any policy server transaction.


8 47
CLI Reference Guide

System
Policy Server
TABLE 8 17 Local Policy Server Configuration Parameters (Continued)

Parameter
Length/
Range
retryTimer
N/A
Specifies the time (in milliseconds) for SBC 5x00 to wait for the
response from the local policy server. (default = 2500).
state
N/A
NOTE: If changing the state, ensure mode is set to

outofservice.
Description
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.
transactionTimer
50-60000 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
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
8 48
enabled
active
dryUp
2500
2500

CLI Reference Guide

Policy Server
System
Remote Policy Server Configuration

Command Syntax
% set system policyServer remoteServer <softswitch_name>
keepAliveTimer <1-60 seconds>
mode <active|alternate|outOfService|standby>
portNumber <softswitch port number>
retries <0-32>
retryTimer <# milliseconds>
subPortNumber <port number for subscriber data>
transactionTimer <50-60000 milliseconds>
% request system policyServer remoteServer <softswitch_name>
switchBack
Command Parameters
TABLE 8 18 Remote Policy Server Configuration Parameters
Parameter
Length/
Range Description
remoteServer
N/A
The name of the remote policy server.
action
N/A
Use this object to specify the action to take against the policy server.
dryup (default) All queued transactions are processed to
completion unless retries expire.
force All queued transactions are dropped immediately.
ipAddress
N/A
The IPv4 or IPv6 address of the remote policy server.

IPv4 Uses dotted decimal form (for example 128.127.50.224).
IPv6 Uses hexadecimal/colon form (for example,
1280:1276:3350:2224:2222:3333:8888:1245 or
fd00:21:445:128::7880).
keepAliveTimer
1-60
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 (default = 5).

8 49
CLI Reference Guide

System
Policy Server
TABLE 8 18 Remote Policy Server Configuration Parameters (Continued)

Parameter
Length/
Range Description
mode
N/A
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.
portNumber
1-65535 The logical port number used for IP communication with the remote
policy server. (default = 3055).
retries
0-32
The number of times to retry any remote policy server transaction.

(default = 1).
retryTimer
N/A
The time (in milliseconds) for SBC 5x00 to wait for the response from
the remote policy server. (default = 2500).
state
N/A
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.
NOTE: The mode must be set to outOfService before
changing the state.
subPortNumber
1-65535 The port number assigned for the IP address of the policy server
for the specific purpose of communicating subscriber data.
(default = 3053).
switchback
N/A
Use this parameter with the request command to reset SIP

registration count.
transactionTimer
5060000
The time for SBC 5x00 to wait (in milliseconds) for a reply from the
policy server after sending a transaction request. When this timer
expires, a transaction retry is issued based on retries setting.
(default = 2500).
displaylevel
1-64
Command Examples
To set the remote policy server configuration:
% set system policyServer remoteServer RS-1 mode
outOfService
% set system policyServer remoteServer RS-1 ipAddress
10.34.26.151 state enabled
8 50

CLI Reference Guide

Policy Server
System
To view the remote policy server configuration settings:

% show system policyServer remoteServer
remoteServer RS-1 {
ipAddress
10.34.26.151;
state
enabled;
mode
outOfService;
}
To view the status of remote policy server from top-level CLI mode:
> show table system policyServer remoteServer
KEEP
PORT
SUB
TRANSACTION ALIVE RETRY
PORT
NAME IP ADDRESS NUMBER STATE MODE ACTION TIMER TIMER TIMER RETRIES
NUMBER
-----------------------------------------------------------------RS-1 10.35.65.47 3055 enabled active dryUp 2500 5
3053
2500
To reset the SIP registration count of the remote policy server:

% request system policyServer remoteServer RS-1 switchBack
result PASSED
NOTE
In order to use the switchBack command, the remote policy server

must first be configured to allow a manual switchback.

8 51
CLI Reference Guide

System
Security Management
Security Management
This object allows you to configure IPsec and PKI MIB modules for security
management.
IPSec
The Sonus IP security package (IPsec) provides cryptographic protection for
non-media IP traffic.
Command Syntax
% set system security ipsec
ikeDpdInterval <0-3600 seconds>
ikeRetransmitInterval <0-3600 seconds>
ikeRetrasmitCount <0-3>
% show system security ipsec
ikeDpdInterval <0-3600 seconds>
ikeRetransmitInterval <0-3600 seconds>
ikeRetrasmitCount <0-3>
% delete system security ipsec
8 52

CLI Reference Guide

Security Management
System
Command Parameters
TABLE 8 19 Security Management Parameters
Parameter
Length/
Range Description
ikeDpdInterval
0-3600
ikeRetransmitInterval 0-3600
ikeRetrasmitCount
0-3
Dead Peer Detection interval, in seconds. (default = 3600).

IKE re-transmit interval period, in seconds. (default = 10).
Number of IKE retransmits. (default = 3).
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 it
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.

8 53
CLI Reference Guide

System
Security Management
Command Syntax
// Mandatory parameters
% set system security pki
certificate <name, 1-23 characters>
fileName <1-23 characters>
type <remote|local>
// Non-mandatory parameter
% set system security pki
passPhrase <pass phrase>
% show system security pki
certificate <name>
% show system security pki
fileName <file name>
type <remote|local>
% delete system security pki
Command Parameters
TABLE 8 20 Security Management Parameters
Parameter
Length/
Range Description
certificate
N/A
Collection of certificates configured on SBC 5x00.
fileName
N/A
Certificate of content file name.
passPhrase
N/A
Specifies the pass-phrase to decrypt RSA private key in PKCS12

file.
8 54

CLI Reference Guide

Security Management
System
TABLE 8 20 Security Management Parameters (Continued)

Parameter
Length/
Range Description
state
N/A
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.
Command Example
To display security management configuration:
% show system security
pki {
certificate cert2 {
fileName file1;
type
local;
}}

8 55
CLI Reference Guide

System
Server Administration
This object allows you to assign server module roles, set the coredump server
profile, and perform server actions such as restart, soft reset and start software
upgrade.
Command Syntax
% set system serverAdmin <name>
coredumpProfile <name>
% request system serverAdmin <name>
identify
removeCoredump
coreDumpFilename <file name>
restart
softReset
package <name>
rpmName <name>
versionCheck <perform|skip>
Command Parameters
Set Command Parameters
TABLE 8 21 System Server Admin Parameters (set command)
Parameter
Length/
Range Description
<serverName>
N/A
The unique name of the server.
coredumpProfile
N/A
Core Dump Profile name.
role
N/A
Use this parameter to specify the server module role. When set to
primary, role designates a server for internal processing.
primary (default)
secondary
8 56

CLI Reference Guide

System
Request Command Paramters

TABLE 8 22 System Server Admin Parameters (request)
Parameter
Length
/Range Description
<serverName>
N/A
The unique name of the server.
identify
0-255
Turn on/off the locator LED of the specified server for the amount
of time set with the duration sub-parameter below.
duration The duration (in seconds) to illuminate the locator
LED of specified server. The LED illuminates for the specified
number of seconds and then extinguishes. A duration of 0
turns off the locator LED and a duration of 255 turns on the
locator LED indefinitely. If the duration is not specified, 15
seconds is set as the default value.
N/A
removeCoredump
Use this object to remove the specified coredump from the

chosen server.
coredumpFileName The name of the coredump file.
restart
N/A
Restart the specified server.
softReset
N/A
Restart the application on the server without rebooting the server.
N/A
Use this control to start a software upgrade on the specified

server.
package Name of the new package.
rpmName Name of the rpm/package, if different from the file
name of the .tar.gz.
versionCheck Use this flag to perform/skip version
checking as part of software upgrade.
perform
skip
Command Example
To display server administration configuration:
% show system serverAdmin
serverAdmin merc {
coredumpProfile default;
role
primary;
To illuminate the locator LED of server FUBBCANARYb for two minutes:

% request system serverAdmin FUBBCANARYb identify duration
120
result success
reason Identifying server(s)...

8 57
CLI Reference Guide

System
8 58


Attachment 7 SBC 5x00 CLI Reference Guide

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Attachment 7 SBC 5x00 CLI Reference Guide

Enviado por

Direitos autorais:

Formatos disponíveis

CLI Reference Guide

Session Border Controller 5x00

Sonus Technical Publication

Sonus Part Number:

Disclaimer and Restrictions

Compliance with Applicable Laws and Export Control Laws

About This Guide

Chapter 1 Introduction to CLI Commands

SBC 5x00 CLI Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

CLI Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6

Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Chapter 2 System-Level CLI Operations

550-05505 Version 1 Release V03.01.00

CLI Reference Guide

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

Chapter 3 Configure CLI Operations

CLI Reference Guide

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Chapter 4 Address Context

DNS Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

IP Access Control List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16

IP Interface Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25

Link Detection Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

CLI Reference Guide

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41

NAT Direct Media Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-61

RTP Server Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63

Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64

CLI Reference Guide

Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Call Trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17

550-05505 Version 1 Release V03.01.00

CLI Reference Guide

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29

Monitor Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30

Monitor Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31

QoE Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34

CLI Reference Guide

Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47

SIP Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49

Chapter 6 Operations and Maintenance (OAM)

Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

CLI Reference Guide

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21

Local Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25

Radius Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27

Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Digit Parameter Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

CLI Reference Guide

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-33

Digit Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35

DTMF Trigger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42

Feature Control Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44

IP Signaling Peer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45

Transcoding Configuration Command Example 58

550-05505 Version 1 Release V03.01.00

CLI Reference Guide

Tone Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-73

CLI Reference Guide

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97

550-05505 Version 1 Release V03.01.00

CLI Reference Guide

SIP/CPC Cause Code Mapping Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-248