Vous êtes sur la page 1sur 762

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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Configuring DNS A/SRV and NAPTR Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11

Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15

IP Access Control List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
System ACL Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23

IP Interface Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29

IPsec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40

Link Detection Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41


550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I vii

CLI Reference Guide


TOC

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


Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62

RTP Server Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63

Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64


Static IP Routes for IP interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72
dnsGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
gwSigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74
gwTrunkGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-77
h323SigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-80
h323TrunkGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
id. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91

I viii
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


TOC

ipPeer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-92
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-95
messageManipulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
remoteDeviceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
sipSigPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-98
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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15

Call Trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17


Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23

Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24

Country . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27

License. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I ix

CLI Reference Guide


TOC

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29


Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29

Monitor Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30

Monitor Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32

NPA/Nxx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33

QoE Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34

Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37

Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40

Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Configuring Gateway Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Configuring H.323 Signaling Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Configuring SIP Peer Overload Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Configuring SIP Signaling Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Ix
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


TOC

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


Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48

SIP Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49


Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49

Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Configuring Radius Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14

Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15


Filter Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Filter Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Subsystem Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Type Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I xi

CLI Reference Guide


TOC

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21


Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23

Local Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26

Radius Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28

SNMP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30

Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32

Chapter 7 Profiles
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Call Parameter Filter Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4


Crankback Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Element Routing Priority Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Holiday . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Time Range Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13

Digit Parameter Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14


I xii
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


TOC

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


Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40

DTMF Trigger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-42
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-43

Feature Control Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-44

IP Signaling Peer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-45
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-58

Transcoding Configuration Command Example 58


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I xiii

CLI Reference Guide


TOC

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


Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
Tone Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-76
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-76
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-77
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-78

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Crypto Suite Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-80
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-81
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-81
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Key Management Protection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
IPSec Protection Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85
TLS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-86
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-86
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-87
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-88

Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Class of Service Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-89
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-90
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Dynamic Blacklist (DBL) Policer Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-91
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-92
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-93
Disconnect Signaling Sequence Profile (SSP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-93
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-93
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-94
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-95
Disconnect Treatment Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-95
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-95
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Emergency Call Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97

I xiv
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


TOC

Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-97


Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Path Check Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-98
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-99
SIP ARS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
SIP Security Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-104

Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
X-Header Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-105
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-107
IP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-111
H.323 Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-111
SIP Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-118
ISUP Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-158
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-158
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-167
Number Globalization Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-203
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-203
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-205
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-208
SCTP Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-209
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-209
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-210
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-210
Signaling Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-212
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-212
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-216
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Signaling QoS KPI Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-232
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-233
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-234
SIP Adaptor Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-235
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-235
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-238
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-246

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-265
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
IP Policing Alarm Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-266
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-267
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-270
Overload Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-273
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-273
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-274
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-275

Chapter 8 System
Admin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
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 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
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
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
I xvi
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


TOC

Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19

Interval Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21

IP Policing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22

Juniper SRC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25

Logical Management IP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27

Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29

Media Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31

Management IP Interface Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-34
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35

Management Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-41

NTP Services Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-42


Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-42
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-43
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-44

Policy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45


Global Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-46
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-46
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I xvii

CLI Reference Guide


TOC

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


Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-47
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-47
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-48
Remote Policy Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Command Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-50

Security Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52


IPSec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52
Command Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-52
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-53
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
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-56
Set Command Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-56
Request Command Paramters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
Command Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57

I xviii
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
550-05505 Version 1 Release V03.01.00

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
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00

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
commands that you may use to create, configure, and view information about it.
Chapter 8, "System", presents a description of system object and the CLI
commands that you may use to create, configure, and view information about it.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

I xxvii

CLI Reference Guide

I xxviii

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00

11

CLI Reference Guide


Introduction to CLI Commands

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


SBC 5x00 CLI Modes

Introduction to CLI Commands

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

13

CLI Reference Guide


Introduction to CLI Commands

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
request Make system-level requests
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
top Exit to top level and optionally run command
up Exit one level of 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


SBC 5x00 CLI Modes

Introduction to CLI Commands

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

15

CLI Reference Guide


Introduction to CLI Commands

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


CLI Operation

Introduction to CLI Commands

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]

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

17

CLI Reference Guide


Introduction to CLI Commands

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

- Exit the management session

request

- Make system-level requests

reset

- Reset the terminal

set

- Set CLI properties

set-path

- Set relative show path

show

- Show information about the system

source

- File to source

top
command

- Exit to top level and optionally run

up

- Exit one level of configuration

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Getting Help

Introduction to CLI Commands

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

request

- Make system-level requests

revert

- Copy configuration from running

rollback - Roll back database to last committed version


set

- Set a parameter

show

- Show a parameter

status
- Display users currently editing the
configuration
top

- Exit to top level and optionally run command

up

- Exit one level of configuration

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

19

CLI Reference Guide


Introduction to CLI Commands

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:
Possible completions:
addressContext - A container of objects that correspond
to
a specific IP Addressing domain.
global

- Global objects that are applicable Node


wide

oam

- Operations and Maintenance objects.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System-Level CLI Operations

CHAPTER 2

System-Level CLI Operations

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> ?
Possible completions:
change-password Change your password
commit

Confirm a pending commit

configure Manipulate software configuration information


exit

Exit the management session

help

- Provide help information

quit

- Exit the management session

request

- Make system-level requests

reset

- Reset the terminal

set

- Set CLI properties

set-path

- Set relative show path

show

- Show information about the system

source

- File to source

top

- Exit to top level and optionally run command

up

- Exit one level of configuration

Command details are explained in the following sub-sections.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

21

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

23

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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:

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

25

CLI Reference Guide


System-Level CLI Operations

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 the address context. The address context is a container of
objects that correspond to a specific IP Addressing domain.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

> 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

Name of the address context. The address context is a container of


objects that correspond to a specific IP Addressing domain.
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
Name of the address context. The address context is a container of
objects that correspond to a specific IP Addressing domain.

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:
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

27

CLI Reference Guide


System-Level CLI Operations

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
> request addressContext <addressContext name>
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
> request addressContext <addressContext name>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
> request addressContext <addressContext name>
sipRegistrationDeleteById id <registration id>
TABLE 2 6

sipRegistrationDeleteById request Parameters

Parameter

Length/
Range Description

addressContext

1-23

sipRegistrationDeleteById N/A
N/A

id

Name of the address context. The address context is a


container of objects that correspond to a specific IP
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
> request addressContext <addressContext name>
sipRegistrationDeleteByIp ipAddress <ip address>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

29

CLI Reference Guide


System-Level CLI Operations

TABLE 2 7

System Commands

sipRegistrationDeleteByIp request Parameters

Parameter

Length/
Range Description

addressContext

1-23

sipRegistrationDeleteByIp N/A
N/A

ipAddress

Name of the address context. The address context is a


container of objects that correspond to a specific IP
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
> request addressContext <addressContext name>
sipSubCountReset
TABLE 2 8

sipSubCountReset request Parameters

Parameter

Length/
Range Description

addressContext

1-23

Name of the address context. The address context is a


container of objects that correspond to a specific IP
Addressing domain.

sipSubCountReset

N/A

Reset SIP subscription count.

Example
> request addressContext default sipSubCountReset
result success
reason Subscription Count is Reset

2 10

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

sipSubscriptionDelete
Command Syntax
> request addressContext <addressContext name>
sipSubscriptionDelete <subcription id>
TABLE 2 9

sipSubscriptionDelete request Parameters

Parameter

Length/
Range Description

addressContext

1-23

Name of the address context. The address context is a


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

Name of the address context. The address context is a


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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 11

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 13

CLI Reference Guide


System-Level CLI Operations

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

commitSoftwareUpgrade

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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).

revertSoftwareUpgrade

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/

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 15

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 17

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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:
Possible completions:
addressContext - Objects scoped to a specific IP addressing domain.
alarms

- Alarm Management.

global

- Global objects that are applicable Node wide.

oam

- Operations and Maintenance objects.

profiles

- Profiles of configuration shared by multiple objects.

system

- System-level configuration.

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
Possible completions:
cli

- Display cli settings

configuration - Display current configuration


notification

- Display notifications

status

- Display current system status

table

- Display current configuration and status as a table

users

- Display currently logged on users

utils

- System utilities

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 19

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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>
state <disabled|enabled>
server
ipAddress <ip address>
priority <0-100>
recursionDesired <false|true>
state <disabled|enabled>
weight <0-100>
type <ip|mgmt|none>
ipAccessControlList
rule
ipInterfaceGroup
ipInterface
action
altIpAddress
altPrefix
bandwidth
bwContingency
ceName

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 21

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 23

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 25

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 27

CLI Reference Guide


System-Level CLI Operations

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
playoutTimeseriesThreshold1
playoutTimeseriesThreshold2
rtpDtmfRelay
sidHangoverTime
sidMaxNoiseFloor
sidMaxTime
sidMinNoiseFloor
sidMinTime
toneThreshold
toneThresholdState
universalCompressionThreshold
universalCompressionThresholdState
ethernetPort
mgmtAdmin
2 28

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 29

CLI Reference Guide


System-Level CLI Operations

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.

"addressContext" on page 2 30
"alarms" on page 2 78
"global" on page 2 79
"oam" on page 2 101
"system" on page 2 107

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

> 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
linkDetectionGroupStatistics
linkDetectionGroupStatus
> show status addressContext linkDetectionGroupStatistics
<ldgs name>
doubleFailures
failures
singleFailures
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 31

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

> 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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 33

CLI Reference Guide


System-Level CLI Operations

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

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.

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>
ipAddress <ip address>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 35

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


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.
displaylevel Sets number of levels to display.

2 36

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


Parameter

Length/
Range Description

ipAccessControlList
(continued)

N/A

ipAclRulesByPrecedence IP ACL rules by


precedence.
displaylevel Sets number of levels to display.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 37

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


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).
displaylevel Sets number of levels to display.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 39

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


Parameter

Length/
Range Description

sipActiveGroupRegStatus

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 41

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


Parameter

Length/
Range Description

sipRegCountStatistics

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.

sipSubCountStatistics

N/A

Use this object to display the SIP relayed subscription count


statistics for the SIP endpoints or node.
entry Name of the system.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 43

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


Parameter

Length/
Range Description

sipSubscriptionStatus

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

surrRegCountStatistics

N/A

Surrogate registration count statistics for the node.


entry Name of the system.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


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

zoneCurrentStatistics

N/A

callCurrentStatistics
callFailureCurrentStatistics
callFailureIntervalStatistics
callIntervalStatistics
gwSigPortStatistics
gwSigPortStatus
h323SigPortStatistics
h323SigPortStatus
peerPathchkStatus
peerSurrRegStatus
sipArsStatus
sipCurrentStatistics
sipIntervalStatistics
sipPeerCacStatus
sipRegAdaptiveNaptLearningStatistics
sipSigConnStatistics
sipSigConnStatus
sipSigPortStatistics
sipSigPortStatus
sipSigPortTlsStatistics
sipSigTlsSessionStatus
sonusSipSigPeerOvldStatusEntry
trafficControlCurrentStatistics
trafficControlIntervalStatistics
trunkGroupQoeStatus
trunkGroupStatus

The Zone Statistics Current table entries.


displaylevel To display different levels of output
information in show commands.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 45

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 15 show status addressContext Parameters (Continued)


Parameter

Length/
Range Description

zoneCurrentStatistics
(continued)

N/A

egressSipRegPolicing Number of outgoing SIP


Registrations failed due to registration rate.
ingressFailBWLimit Number of incoming failed calls
due to bandwidth limit.
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
Registrations failed due to registration rate.

zoneIntervalStatistics

N/A

The Zone Statistics Interval 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.
egressSipRegPolicing Number of outgoing SIP
Registrations failed due to registration rate.
ingressFailBWLimit Number of incoming failed calls
due to bandwidth limit.
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 registration limit.
ingressSipRegPolicing Number of incoming SIP
Registrations failed due to registration rate.
intervalValid Use to indicate valid interval. Options:
true
false
time System up time when the interval statistics is
collected.

2 46

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 15 show status addressContext Parameters (Continued)


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
across all IP trunks in this zone.
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.
displaylevel To display different levels of output
information in show commands.
emergencyCallsBwUsage Current media bandwidth in
use for emergency calls across all IP trunks in this zone.
inboundCallsUsage Current inbound usage count
across all IP trunks in this zone.
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

sai = security association index

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 47

CLI Reference Guide


System-Level CLI Operations

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

sai = security association index


ipsecSaStatistics <spi>

N/A

IPSEC SA statistics. The spi options are:

inBytesCount
inPacketDiscardAntiReplay
inPacketDiscardFailedIntegrity
inPacketsCount
localIpAddr
outBytesCount
outPacketsCount
peerIpAddr
remoteSpi

spi = security parameter index


ipsecSaStatus <local spi>

IPSEC SA status. The spi options are:

bytesRemaining
encType|ikeSaIndex
integrityType
localSelector
localTerminationAddr
remoteSPI
remoteSelector
remoteTerminationAddr
secondsRemaining
selectorName|
upperLayerProtocol

spi = security parameter index

2 48

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
ISAKMP packets discarded as a result of matching a
discard no state rule.
inPacketDiscardProtected Number of incoming
ISAKMP packets discarded as a result of matching a
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
ISAKMP packets discarded as a result of matching a
discard SPD rule.
outPacketDiscardProtected Number of outgoing
ISAKMP packets discarded as a result of matching a
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 49

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters


Parameter

Length/
Range Description

callCurrentStatistics

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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter
callCurrentStatistics
(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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 51

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
for this trunk group.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
for the specified interval.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 53

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
trunk group for the specified interval.
inCallFailNoResources Number of inbound failed
calls because there was an unavailable resource for this
trunk group for the specified interval.
inCallFailNoRoutes Number of inbound failed calls
because there was no route available for this trunk group
for the specified interval.
inCallFailNoService Number of inbound failed
calls because there was an unavailable service for this
trunk group for the specified interval.
inCallFailProtocolError Number of inbound
failed calls because there was a protocol error for this
trunk group for the specified interval.
inCallFailUnspecified Number of inbound failed
calls for an unspecified reason for this trunk group for the
specified interval.
intervalValid Use to indicate valid interval. Options:
true
false
invalidSPCallsFailed Number of failed calls due
to mismatched ingress signaling port from CP according
to RCB for the specified interval.

2 54

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

callFailureIntervalStati N/A
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
for the specified interval.
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
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
for the specified interval.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 55

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

callFailureIntervalStati N/A
stics (continued)

callIntervalStatistics

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
group for the specified interval.
inCallAttempts Number of inbound call attempts on
this trunk group for the specified interval.
inCalls Number of completed inbound calls on this
trunk group for the specified interval.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter
callIntervalStatistics
(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
for the specified interval.
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).
maxPktOutage Single longest maximum reported
packet outage duration (in milliseconds) experienced
during specified performance interval for this trunk group.
maxPktOutage Single longest maximum reported
packet outage duration (in milliseconds) experienced
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
trunk group for the specified interval.
outCallAttempts Number of outbound call attempts
on this trunk group for the specified interval.
outCalls Number of completed outbound calls on this
trunk group for the specified interval.
outUsage Specifies the usage in the outbound
direction for this trunk group in seconds in the current
interval. The trunk group usage is defined as the time a
trunk is seized to the time a trunk is released.
playoutBufferAcceptable 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
trunk group for the specified interval.
playoutBufferPoor Number of calls with all subintervals reporting POOR or better playout buffer quality
for this trunk group for the specified interval.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 57

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

callIntervalStatistics
(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
trunk group for the specified interval.
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
group for the specified interval.
time System up time when interval statistics is
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
being used between gateways.
FromPdusReceived The total number of signaling
PDUS received from this remote Gateway for incoming
calls.

2 58

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
being used between gateways.
ToLnkMinorVer The minor version of link protocol
being used between gateways.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 59

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

h323SigPortStatistics

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 61

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

sipCurrentStatistics

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
(NonInvite) messages.
byeRetransmit Total number of (interval) Bye
messages ReTransmitted.
cancelReTransmit Total number of (interval) Cancel
messages ReTransmitted.
otherReTransmit Total number of (interval) Other
messages ReTransmitted.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 63

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

sipIntervalStatistics

N/A

The SIP trunk group interval SIP statistics. Options are:


byeRetransmit Total number of (interval) Bye
messages ReTransmitted.
cancelReTransmit Total number of (interval) Cancel
messages ReTransmitted.
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.
intervalValid Use to indicate valid interval. Options:
true
false
invReTransmit Total number of (interval) Invite
messages Re-transmitted.
otherReTransmit Total number of (interval) Other
messages ReTransmitted.
rcv1xx Total number of (interval) received 1xx msg
except 18x messages.
rcv2xx Total number of (interval) received 2xx (Invite)
messages.
rcv3xx Total number of (interval) received 3xx
messages.
rcv4xx Total number of (interval) received 4xx
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter
sipIntervalStatistics
(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.
snd4xx Total number of (interval) sent 4xx messages.
snd5xx Total number of (interval) sent 5xx messages.
snd6xx Total number of (interval) sent 6xx 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 65

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter
sipIntervalStatistics
(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
(NonInvite) messages.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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.
time System up time when interval statistics is
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 67

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
rejected due to endpoint CAC call rate.
egressNotifysAllowed Number of egress notify
allowed for this peer.
egressOptionsAllowed Number of egress options
allowed for this peer.
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
rejected due to endpoint CAC call rate.
egressRefersAllowed Number of egress refer
allowed for this peer.
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
rejected due to endpoint CAC call rate.
ingressCallsActive Number of ingress calls
currently active for peer.
ingressCallsAllowed Number of ingress calls
allowed for this peer.
ingressDblAggregateMessageRejectsRate
Number of ingress aggregate message rejected due to
endpoint CAC call rate.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
allowed for this peer.
ingressOptionsAllowed Number of ingress options
allowed for this peer.
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
rejected due to endpoint CAC call rate.
ingressRefersAllowed Number of ingress refer
allowed for this peer.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 69

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

sipRegAdaptiveNaptLearni N/A
ngStatistics

sipSigConnStatistics

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

sipSigPortStatistics

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

sipSigPortTlsStatistics

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.
displaylevel To display different levels of output
information in show commands.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 71

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


Parameter

Length/
Range Description

sipSigPortTlsStatistics
(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.

sipSigTlsSessionStatus

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
for this trunk group.
cant The current number of call cancelled due to CANT
for this trunk group.
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
for this trunk group.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 73

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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
this trunk group for the specified interval.
accSkip The number of calls skipped due to ACC for
this trunk group for the specified interval.
canf The number of calls cancelled due to CANF for
this trunk group for the specified interval.
cant The number of calls cancelled due to CANT for
this trunk group for the specified interval.
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
trunk group for the specified interval.
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
this trunk group for the specified interval.
strSkip The number of calls skipped due to STR for
this trunk group for the specified interval.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 17 show status addressContext zone Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 75

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 17 show status addressContext zone Parameters (Continued)


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 77

CLI Reference Guide


System-Level CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 79

CLI Reference Guide


System-Level CLI Operations

System Commands

originationAllowedTable
originationBlockedTable
policyReqCounters
serviceUsageCounters
sipCounters
sipE911Counters
translatedDestAllowedTable
translatedDestBlockedTable
> show status global policyServer
policyReqCounters
totalReqsNoExtSvc
totalTimeNoExtSvc
averageTimeNoExtSvc
totalRequestsExtSvc
totalTimeExtSvc
averageTimeExtSvc
extTime
averagExtTime
totalTimeouts
totalTimeTORequests
averageTimeTORequests
totalNonSsRequests
totalTimeNonSsRequests
averagTimeNonSsRequests
> show status global policyServer
serviceUsageCounters
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

authcodeScreening
authcodeBlocking
authcodeForcedRouting
authcodeHiFraudBlocking
authcodeSacNonSacRoutes
infodigitScreening
infodigitBlocking
infodigitForcedRouting
infodigitHiFraudBlocking
infodigitSacNonSacRoutes
softswitchScreening
softswitchBlocking
softswitchForcedRouting
softswitchHiFraudBlocking
softswitchSacNonSacRoutes
> show status global policyServer
lnpTfCounters
numLNPRequests
numSCPRequests
numDNRequests
numTimedOutRequests
numRequestErrors
tfcNumRequests
tfcNumRequestsToScp
tfcNumRequestsTranslated
tfcNumTimedOutRequests
tfcNumRequestErrors
> show status global policyServer
mwiServiceCounters
MWIService
MWIUpdateService
> show status global policyServer
dnsEnumCounters
DNSRequestsSent
DNSResponsesReceived
ENUMRequestsSent
ENUMResponsesReceived
KARequestsSent
KAResponsesReceived
ENUMResponseSuccess
ENUMResponseGeneralFailure
ENUMResponseNoMemory
ENUMResponseInvalidParameter
ENUMResponseNoName
ENUMResponseNoData
DNSCanceledRequests
ENUMCanceledRequests
longTermAverageTransTime
shortTermAverageTransTime
NAPTRRscRecordReqSent
NAPTRRscRecordRspReceived
NAPTRRscRecordCanceledReq

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 81

CLI Reference Guide


System-Level CLI Operations

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
> show status global policyServer
failureCounters
numQueryError
numInternalError
numExternalError
> show status global policyServer
lnpGsxTable <ipaddress>
gsxName <gsxName>
gsxMisroutedCalls
gsxInvalidNumbers
> show status global policyServer
sipE911Counters
reqSent
totalRspRcvd
successfulRspRcvd
failedRspRcvd
reqRetry
> show status global policyServer
sipCounters
sipInviteSent
sip2xxRcvd
sip3xxRcvd
sip4xxRcvd
sip5xxRcvd
sip6xxRcvd
> show status global callCountStatus all

2 82

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

> 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
associatedGcidLegId2
associatedGcidLegId3
associatedGcidLegId4
associatedGcidLegId5
associatedGcidLegId6
callDuration
calledNumber
callingNumber
egressLocalIpSockAddr
egressRemoteIpSockAddr
egressSrtcpAuth
egressSrtcpCrypto
egressSrtpAuth
egressSrtpCrypto
egressVideoLocalIpSockAddr
egressVideoRemoteIpSockAddr
ingressLocalIpSockAddr
ingressRemoteIpSockAddr
ingressSrtcpAuth
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 83

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 85

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 87

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 19 show status global Parameters (Continued)


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 19 show status global Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 89

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 19 show status global Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 19 show status global Parameters (Continued)


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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 91

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 19 show status global Parameters (Continued)


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.
sip3xxRcvd Counter that tracks the number of 3XX
responses which have been received by SCPA process
for INVITE transactions.
sip4xxRcvd Counter that tracks the number of 4XX
responses which have been received by SCPA process
for INVITE transactions.
sip5xxRcvd Counter that tracks the number of 5XX
responses which have been received by SCPA process
for INVITE transactions.
sip6xxRcvd Counter that tracks the number of 6XX
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 19 show status global Parameters (Continued)


Parameter
tcpGeneralGroupStatist
ics

Length/
Range
N/A

Description
Collection of TCP general group information for the specified
instance. Options are:
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


instance. Options are:
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 93

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

Number of DNS A Resource Record


Responses with Host_Not_Found Failure.

AResourceRecordRspNoData

N/A

Number of DNS A Resource Record


Responses with
Valid_Name_But_No_Data_Record Failure.

AResourceRecordRspNoRecovery

N/A

Number of DNS A Resource Record


Responses with
Non_Recoverable_Name_Server_Error
Failure.

AResourceRecordRspSuccess

N/A

Number of Successful DNS A Resource


Record Responses.

AResourceRecordRspTryAgain

N/A

Number of DNS A Resource Record


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

Total number of ENUM responses with


Valid_Name_But_No_Data_Record Failure.

ENUMResponseNoMemory

N/A

Total number of ENUM responses with


Memory_Unavailable Failure.

ENUMResponseNoName

N/A

Total number of ENUM responses with


Name_Does_Not_Exist Failure.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 95

CLI Reference Guide


System-Level CLI Operations

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

Number of DNS NAPTR Resource Record


responses with
Valid_Name_But_No_Data_Record Failure.

NAPTRResourceRecordRspNoName

N/A

Number of DNS NAPTR Resource Record


responses with Name_Does_Not_Exist
Failure.

NAPTRRscRecordCanceledReq

N/A

Number of DNS NAPTR Resource Record


requests canceled by ERE.

NAPTRRscRecordReqSent

N/A

Number of DNS NAPTR Resource Record


requests sent by ERE.

NAPTRRscRecordRspGeneralFailure

N/A

Number of DNS NAPTR Resource Record


responses with General Failure.

NAPTRRscRecordRspNoMemory

N/A

Number of DNS NAPTR Resource Record


responses with Memory_Unavailable Failure.

NAPTRRscRecordRspReceived

N/A

Number of DNS NAPTR Resource Record


responses received by ERE.

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

Number of DNS SRV Resource Record


requests sent by ERE.

SRVResourceRecordResponsesReceived N/A

Number of DNS SRV Resource Record


responses received by ERE.

SRVResourceRecordRspGeneralFailure N/A

Number of DNS SRV Resource Record


responses with General Failure.

SRVResourceRecordRspInvalidParam

N/A

Number of DNS SRV Resource Record


responses with Invalid_Parameter Failure.

SRVResourceRecordRspNoData

N/A

Number of DNS SRV Resource Record


responses with
Valid_Name_But_No_Data_Record Failure.

SRVResourceRecordRspNoMemory

N/A

Number of DNS SRV Resource Record


responses with Memory_Unavailable Failure.

2 96

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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


Parameter

Length/
Range Description

SRVResourceRecordRspNoName

N/A

Number of DNS SRV Resource Record


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.

550-05505 Version 1 Release V03.01.00

2 97

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 23 show status global policyServer serviceUsageCounters Parameters


Parameter

Length/
Range Description

serviceUsageCounters

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

Counter that tracks the number of times the Authcode


SAC/Non-SAC Routing service is executed.

authcodeScreening

N/A

Counter that tracks the number of times the Authcode


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


Routing Service is executed.

cicScreening

N/A

Counter that tracks number of times CIC Screening


Service is executed.

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


Service is executed.

gwForcedRouting

N/A

Counter that tracks number of times Gateway Forced


Routing Service is executed.

gwHiFraudBlocking

N/A

Counter that tracks number of times Gateway HiFraud


Blocking Service is executed.

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


Screening Service is executed.

infodigitBlocking

N/A

Counter that tracks number of times the Infodigit


Blocking service is executed.

2 98

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

Counter that tracks number of times the Infodigit


HiFraud Blocking service is executed.

infodigitSacNonSacRoutes

N/A

Counter that tracks number of times the Infodigit SAC/


Non-SAC Routing service is executed.

infodigitScreening

N/A

Counter that tracks number of times the Infodigit


Screening Service is executed.

nonSubsBlocking

N/A

Counter that tracks number of times Subscriber Blocking


Service is executed.

nonSubsScreening

N/A

Counter that tracks number of times Non Subscriber


Screening Service is executed.

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


Blocking service is executed.

softswitchForcedRouting

N/A

Counter that tracks number of times the SoftSwitch


Forced Routing service is executed.

softswitchHiFraudBlocking

N/A

Counter that tracks number of times the SoftSwitch


HiFraud Blocking service is executed.

softswitchSacNonSacRoutes

N/A

Counter that tracks number of times the SoftSwitch


SAC/Non-SAC Routing service is executed.

softswitchScreening

N/A

Counter that tracks number of times the SoftSwitch


Screening Service is executed.

subsBlocking

N/A

Counter that tracks number of times Subscriber Blocking


Service is executed.

subsForcedRouting

N/A

Counter that tracks number of times Subscriber Forced


Routing Service is executed.

subsHiFraudBlocking

N/A

Counter that tracks number of times Subscriber HiFraud


Blocking Service is executed.

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


Screening Service is executed.

tgBlocking

N/A

Counter that tracks number of times Trunkgroup


Blocking Service is executed.

tgForcedRouting

N/A

Counter tracks number of times Trunkgroup Forced


Routing Service is executed.

tgHiFraudBlocking

N/A

Counter that tracks number of times Trunkgroup


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

Counter that tracks number of times Trunkgroup


Screening Service is executed.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 99

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 101

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 103

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 24 show status oam Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 105

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 24 show status oam Parameters (Continued)


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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 107

CLI Reference Guide


System-Level CLI Operations

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
numCallFailOtherOnG723
numCallFailOtherOnG726
numCallFailOtherOnG729
numCallFailOtherOnG7221
numCallFailOtherOnIlbc
numCallFailOtherOnTone
numCallSuccessNoAmr
numCallSuccessNoAmrwb
numCallSuccessNoDspAllocFailure
numCallSuccessNoEfr
numCallSuccessNoEvrc
numCallSuccessNoEvrcb0
numCallSuccessNoG711Packet
2 108

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

numCallSuccessNoG722
numCallSuccessNoG723
numCallSuccessNoG726
numCallSuccessNoG729
numCallSuccessNoG7221
numCallSuccessNoIlbc
numCallSuccessNoTone
numCallSuccessWithDspAlloc1Failure
dspCallIntervalStatistics <seq. #>
intervalValid
numCallFailNoAmr
numCallFailNoAmrwb
numCallFailNoEfr
numCallFailNoEvrc
numCallFailNoEvrcb0
numCallFailNoG711Packet
numCallFailNoG722
numCallFailNoG723
numCallFailNoG726
numCallFailNoG729
numCallFailNoG7221
numCallFailNoIlbc
numCallFailNoTone
numCallFailOtherOnAmr
numCallFailOtherOnAmrwb
numCallFailOtherOnEfr
numCallFailOtherOnEvrc
numCallFailOtherOnEvrcb0
numCallFailOtherOnG711Packet
numCallFailOtherOnG722
numCallFailOtherOnG723
numCallFailOtherOnG726
numCallFailOtherOnG729
numCallFailOtherOnG7221
numCallFailOtherOnIlbc
numCallFailOtherOnTone
numCallSuccessNoAmr
numCallSuccessNoAmrwb
numCallSuccessNoDspAllocFailure
numCallSuccessNoEfr
numCallSuccessNoEvrc
numCallSuccessNoEvrcb0
numCallSuccessNoG711Packet
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 109

CLI Reference Guide


System-Level CLI Operations

System Commands

numCallSuccessNoG722
numCallSuccessNoG723
numCallSuccessNoG726
numCallSuccessNoG729
numCallSuccessNoG7221
numCallSuccessNoIlbc
numCallSuccessNoTone
numCallSuccessWithDspAllocFailure
time
dspUsageCurrentStatistics <system_name>
G711PacketAverageAvailCount
G711PacketAverageUsedCount
G711PacketPeakUsedCount
G711SSPacketAverageAvailCount
G711SSPacketAverageUsedCount
G711SSPacketPeakUsedCount
G722AverageAvailCount
G722AverageUsedCount
G722PeakUsedCount
G723AverageAvailCount
G723AverageUsedCount
G723PeakUsedCount
G726AverageAvailCount
G726AverageUsedCount
G726PeakUsedCount
G729AverageAvailCount
G729AverageUsedCount
G729PeakUsedCount
G7221AverageAvailCount
G7221AverageUsedCount
G7221PeakUsedCount
ToneAverageAvailCount
ToneAverageUsedCount
TonePeakUsedCount
amrAverageAvailCount
amrAverageUsedCount
amrPeakUsedCount
amrwbAverageAvailCount
amrwbAverageUsedCount
amrwbPeakUsedCount
efrAverageAvailCount
efrAverageUsedCount
efrPeakUsedCount
2 110

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

evrcAverageAvailCount
evrcAverageUsedCount
evrcPeakUsedCount
evrcb0AverageAvailCount
evrcb0AverageUsedCount
evrcb0PeakUsedCount
ilbcAverageAvailCount
ilbcAverageUsedCount
ilbcPeakUsedCount
dspUsageIntervalStatistics <seq. #>
G711PacketAverageAvailCount
G711PacketAverageUsedCount
G711PacketPeakUsedCount
G711SSPacketAverageAvailCount
G711SSPacketAverageUsedCount
G711SSPacketPeakUsedCount
G722AverageAvailCount
G722AverageUsedCount
G722PeakUsedCount
G723AverageAvailCount
G723AverageUsedCount
G723PeakUsedCount
G726AverageAvailCount
G726AverageUsedCount
G726PeakUsedCount
G729AverageAvailCount
G729AverageUsedCount
G729PeakUsedCount
G7221AverageAvailCount
G7221AverageUsedCount
G7221PeakUsedCount
ToneAverageAvailCount
ToneAverageUsedCount
TonePeakUsedCount
amrAverageAvailCount
amrAverageUsedCount
amrPeakUsedCount
amrwbAverageAvailCount
amrwbAverageUsedCount
amrwbPeakUsedCount
efrAverageAvailCount
efrAverageUsedCount
efrPeakUsedCount
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 111

CLI Reference Guide


System-Level CLI Operations

System Commands

evrcAverageAvailCount
evrcAverageUsedCount
evrcPeakUsedCount
evrcb0AverageAvailCount
evrcb0AverageUsedCount
evrcb0PeakUsedCount
ilbcAverageAvailCount
ilbcAverageUsedCount
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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>
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 113

CLI Reference Guide


System-Level CLI Operations

System Commands

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

memoryUtilIntervalStatistics
mgmtIpInterfaceGroup
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 115

CLI Reference Guide


System-Level CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 25 show status system Parameters (Continued)


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
available on this server.
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
available on this server.
evrc0Utilization Specifies the percentage
utilization of EVRC0 resources on this server.
evrcb0Total Total number of EVRCB0 resources
available on this server.
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.
g722Total Total number of G.722 resources available
on this server.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 117

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 25 show status system Parameters (Continued)


Parameter

Length/
Range Description

dspStatus (continued)

N/A

g722Utilization Specifies the percentage utilization


of G.722 resources on this server.
g726Total Total number of G.726 resources available
on this server.
g726Utilization Specifies the percentage utilization
of G.726 resources on this server.
g729AbTotal Total number of G.729A+B resources
available on this server.
g729AbUtilization Specifies the percentage
utilization of G.729A+B resources on this server.
g7221Total Total number of G.722.1 resources
available on this server.
g7221Utilization Specifies the percentage utilization
of G.722.1 resources on this server.
g7231Total Total number of G.723.1 resources
available on this server.
g7231Utilization Specifies the percentage utilization
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 25 show status system Parameters (Continued)


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.

highAvailabilityPort

N/A

HA Ethernet port configurations and status.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 119

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 25 show status system Parameters (Continued)


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.
displaylevel To display different levels of output
information in show commands.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 25 show status system Parameters (Continued)


Parameter

Length/
Range Description

mgmtIpInterfaceGroup

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.

partNum Identifies the part number of the module.


powerFault Indicates if there is power fault.
present Indicates if the module is present or not.
productName Identifies the name (as given by
manufacturer) of power supply module.
serialNum Identifies the serial number of the power
supply module.
voltageFault Indicates if there is a voltage fault.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 121

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 25 show status system Parameters (Continued)


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).
partNum Identifies the part number of the module.
platformVersion Indicates the platform version
currently running on the server.
serialNum Identifies the serial number of the server
module.
syncStatus Indicates the inter-CE data synchronization
state.
upTime Indicates the server module uptime in days/hours/
minutes/sec.

2 122

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 25 show status system Parameters (Continued)


Parameter

Length/
Range Description

softwareUpgradeStatus

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).
displaylevel To display different levels of output
information in show commands.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 123

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 25 show status system Parameters (Continued)


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.
levelMC2Count Current number of transitions into MC2.
levelMC2TotalTime Current sum of time spent in MC2.
levelMC3Count Current number of transitions into MC3.
levelMC3TotalTime Current sum of time spent in MC3.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

TABLE 2 25 show status system Parameters (Continued)


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.
intervalValid Use to indicate valid interval. Options:
true
false
levelMC1Count Current number of transitions into MC1.
levelMC1TotalTime Current sum of time spent in MC1.
levelMC2Count Current number of transitions into MC2.
levelMC2TotalTime Current sum of time spent in MC2.
levelMC3Count Current number of transitions into MC3.
levelMC3TotalTime Current sum of time spent in MC3.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 125

CLI Reference Guide


System-Level CLI Operations

System Commands

TABLE 2 25 show status system Parameters (Continued)


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;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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;

numCallFailNoG711Packet

0;

numCallFailNoG722

0;

numCallFailNoG723

0;

numCallFailNoG726

0;

numCallFailNoG729

0;

numCallFailNoG7220

0;

numCallFailNoIlbc

0;

numCallFailNoTone

0;

numCallFailOtherOnAmr

0;

numCallFailOtherOnAmrwb

0;

numCallFailOtherOnEfr

0;

numCallFailOtherOnEvrc

0;

numCallFailOtherOnEvrcb0

0;

numCallFailOtherOnG711Packet

0;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 127

CLI Reference Guide


System-Level CLI Operations

System Commands

numCallFailOtherOnG722

0;

numCallFailOtherOnG723

0;

numCallFailOtherOnG726

0;

numCallFailOtherOnG729

0;

numCallFailOtherOnG7220

0;

numCallFailOtherOnIlbc

0;

numCallFailOtherOnTone

0;

numCallSuccessNoAmr

0;

numCallSuccessNoAmrwb

0;

numCallSuccessNoDspAllocFailure

0;

numCallSuccessNoEfr

0;

numCallSuccessNoEvrc

0;

numCallSuccessNoEvrcb0

0;

numCallSuccessNoG711Packet

0;

numCallSuccessNoG722

0;

numCallSuccessNoG723

0;

numCallSuccessNoG726

0;

numCallSuccessNoG729

0;

numCallSuccessNoG7220

0;

numCallSuccessNoIlbc

0;

numCallSuccessNoTone

0;

numCallSuccessWithDspAllocFailure 0;
}
To view the call interval statistics of the DSP Resource pad:
admin@server1> show status system dspRes
dspCallIntervalStatistics
dspCallIntervalStatistics 2 sbx10 {
intervalValid

true;

time

2549;

numCallSuccessNoDspAllocFailure

0;

numCallSuccessWithDspAllocFailure 0;

2 128

numCallFailNoG729

0;

numCallFailOtherOnG729

0;

numCallSuccessNoG729

0;

numCallFailNoG726

0;

numCallFailOtherOnG726

0;

numCallSuccessNoG726

0;

numCallFailNoG711Packet

0;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

numCallFailOtherOnG711Packet

0;

numCallSuccessNoG711Packet

0;

numCallFailNoG723

0;

numCallFailOtherOnG723

0;

numCallSuccessNoG723

0;

numCallFailNoIlbc

0;

numCallFailOtherOnIlbc

0;

numCallSuccessNoIlbc

0;

numCallFailNoEvrcb0

0;

numCallFailOtherOnEvrcb0

0;

numCallSuccessNoEvrcb0

0;

numCallFailNoGsm

0;

numCallFailOtherOnGsm

0;

numCallSuccessNoGsm

0;

numCallFailNoAmrwb

0;

numCallFailOtherOnAmrwb

0;

numCallSuccessNoAmrwb

0;

numCallFailNoG722

0;

numCallFailOtherOnG722

0;

numCallSuccessNoG722

0;

numCallFailNoTone

0;

numCallFailOtherOnTone

0;

numCallSuccessNoTone

0;

numCallFailNoEvrc

0;

numCallFailOtherOnEvrc

0;

numCallSuccessNoEvrc

0;

numCallFailNoG7221

0;

numCallFailOtherOnG7221

0;

numCallSuccessNoG7221

0;

numCallFailNoEfr

0;

numCallFailOtherOnEfr

0;

numCallSuccessNoEfr

0;

}
To view the DSP current usage statistics of the DSP Resource pad:
admin@server1> show status system dspRes
dspUsageCurrentStatistics
dspUsageCurrentStatistics sbx10 {

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 129

CLI Reference Guide


System-Level CLI Operations

System Commands

amrAverageAvailCount

0;

amrAverageUsedCount

0;

amrPeakUsedCount

0;

amrwbAverageAvailCount

0;

amrwbAverageUsedCount

0;

amrwbPeakUsedCount

0;

efrAverageAvailCount

0;

efrAverageUsedCount

0;

efrPeakUsedCount

0;

evrcAverageAvailCount

0;

evrcAverageUsedCount

0;

evrcb0AverageAvailCount

0;

evrcb0AverageUsedCount

0;

evrcb0PeakUsedCount

0;

evrcPeakUsedCount

0;

G711PacketAverageAvailCount
G711PacketAverageUsedCount

0;

G711PacketPeakUsedCount

0;

G711SSPacketAverageAvailCount

0;

G711SSPacketAverageUsedCount

0;

G711SSPacketPeakUsedCount

0;

G7221AverageAvailCount

0;

G7221AverageUsedCount

0;

G7221PeakUsedCount

0;

G722AverageAvailCount

0;

G722AverageUsedCount

0;

G722PeakUsedCount

0;

G723AverageAvailCount

11;

G723AverageUsedCount

0;

G723PeakUsedCount

0;

G726AverageAvailCount

11;

G726AverageUsedCount

0;

G726PeakUsedCount

0;

G729AverageAvailCount

11;

G729AverageUsedCount

0;

G729PeakUsedCount

0;

ilbcAverageAvailCount
ilbcAverageUsedCount
2 130

11;

11;
0;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

ilbcPeakUsedCount

0;

ToneAverageAvailCount

0;

ToneAverageUsedCount

0;

TonePeakUsedCount

0;

}
To view the DSP usage interval statistics of the DSP Resource pad:
admin@server1> show status system dspRes
dspUsageIntervalStatistics
dspUsageIntervalStatistics <system_name> {
intervalValid

true;

time

3449;

amrAverageAvailCount

0;

amrAverageUsedCount

0;

amrPeakUsedCount

0;

amrwbAverageAvailCount

0;

amrwbAverageUsedCount

0;

amrwbPeakUsedCount

0;

efrAverageAvailCount

0;

efrAverageUsedCount

0;

efrPeakUsedCount

0;

evrcAverageAvailCount

0;

evrcAverageUsedCount

0;

evrcb0AverageAvailCount

0;

evrcb0AverageUsedCount

0;

evrcb0PeakUsedCount

0;

evrcPeakUsedCount

0;

G711PacketAverageAvailCount

11;

G711PacketAverageUsedCount

0;

G711PacketPeakUsedCount

0;

G711SSPacketAverageAvailCount

0;

G711SSPacketAverageUsedCount

0;

G711SSPacketPeakUsedCount

0;

G7221AverageAvailCount

0;

G7221AverageUsedCount

0;

G7221PeakUsedCount

0;

G722AverageAvailCount

0;

G722AverageUsedCount

0;

G722PeakUsedCount

0;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 131

CLI Reference Guide


System-Level CLI Operations

System Commands

G723AverageAvailCount

11;

G723AverageUsedCount

0;

G723PeakUsedCount

0;

G726AverageAvailCount

11;

G726AverageUsedCount

0;

G726PeakUsedCount

0;

G729AverageAvailCount

11;

G729AverageUsedCount

0;

G729PeakUsedCount

0;

ilbcAverageAvailCount

11;

ilbcAverageUsedCount

0;

ilbcPeakUsedCount

0;

ToneAverageAvailCount

0;

ToneAverageUsedCount

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;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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.

"addressContext" on page 2 133


"alarms" on page 2 138
"global" on page 2 139
"oam" on page 2 140
"profiles" on page 2 143
"system" on page 2 148

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 133

CLI Reference Guide


System-Level CLI Operations

System Commands

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

2 134

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

numCalls
oosReason <admin|linkDown|notApplicable|portDown|
serverDown|standby>
operState <admnDisabled|admnEnabled|deallocDryup|
deallocForce1|deallocForce2|null|remoteCreated|
remoteCreating|resAllocated|resAllocating>
rxPackets
txPackets
ipsec <disabled|enabled>
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
linkDetectionGroupStatistics
linkDetectionGroupStatus
logicalSigAddressBindingStatus
natDirectMediaGroup
rtpServerTable
sipActiveGroupRegStatus
aorName
contactURI
creationTime
extExpirationTime
intExpirationTime
nextHopIpAddress
nextHopPortNum
regIdIsChild
registrarDomainName
registrarIpAddress
registrarPortNum
state <challenged|completed|deleting|expired|
initiating|null|refreshing|terminated|updating>
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 135

CLI Reference Guide


System-Level CLI Operations

System Commands

sipActiveGroupRegSummaryStatus <SIP Registrars IP


address>
aorName
nextRegIdIsChild
state <challenged|completed|deleting|expired|
initiating|null|refreshing|terminated|updating>
sipActiveRegisterNameStatus
contactURI
creationTime
endPointBehindNapt
externalExpirationTime
internalExpirationTime
natPinholeLearningStatus
nextHopIpAddress
nextHopPortNum
registrarDomainName
registrarIpAddress
registrarPortNum
securityMechanismType
state <challenged|completed|deleting|expired|
initiating|null|refreshing|terminated|updating>
sipDeletedRegStatus
sipDeletedRegisterNameStatus
sipRegCountStatistics
sipRegCountAttempts
sipRegCountCumCompletions
sipRegCountPending
sipRegCountStable
sipRegCountTotal
sipSubCountStatistics
sipSubCountAttempts
sipSubCountCumCompletions
sipSubCountStable
sipSubCountTotal
sipSubscriptionStatus
staticRoute <dest. IP address>
preference
surrRegCountStatistics
surrRegActiveRegCount
2 136

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

surrRegConfiguredCount
zone (zone parameters are listed following this listing)
zoneCurrentStatistics
egressFailBWLimit
egressFailCallLimit
egressFailCallPolicing
egressSipRegFailLimit
egressSipRegPolicing
ingressFailBWLimit
ingressFailCallLimit
ingressFailCallPolicing
ingressSipRegFailLimit
ingressSipRegPolicing
zoneIntervalStatistics
(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
callCurrentStatistics
callFailureCurrentStatistics
callFailureIntervalStatistics
callIntervalStatistics
dnsGroup
gwSigPort
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 137

CLI Reference Guide


System-Level CLI Operations

System Commands

gwSigPortStatistics
gwSigPortStatus
gwTrunkGroup
h323SigPort
h323SigPortStatistics
h323SigPortStatus
h323TrunkGroup
id
ipPeer
messageManipulation
peerPathchkStatus
peerQosStatus
peerSurrRegStatus
remoteDeviceType
sipArsStatus
sipCurrentStatistics
sipIntervalStatistics
sipOcsCallCurrentStatistics
sipOcsCallIntervalStatistics
sipPeerCacStatus
sipRegAdaptiveNaptLearningStatistics
sipSigConnStatistics
sipSigConnStatus
sipSigPort
sipSigPortStatistics
sipSigPortStatus
sipSigPortTlsStatistics
sipSigTlsSessionStatus
sipTrunkGroup
sonusSipSigPeerOvldStatusEntry
trafficControlCurrentStatistics
trafficControlIntervalStatistics
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

> show table alarms


currentStatus
historyStatus

global
The command syntax of the objects related to the show table global
command is shown below.
> 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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 139

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 141

CLI Reference Guide


System-Level CLI Operations

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>
radiusAuthentication
radiusNasIp
radiusServerIp
radiusServerPort
radiusSharedSecret
snmp
community engineId
trapTarget
ipAddress
port
state <disabled|enabled>
trapType <inform|v1|v2>
traps
admin <traps>
dspAdmin
callFailureTrap lackdsp
interval
threshold

2 142

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
command is shown below.
> 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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 143

CLI Reference Guide


System-Level CLI Operations

System Commands

timeMatching
timeZone
digitParameterHandling
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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
uriParameterManipulation
uriType
userInfoManipulation
numberTranslationCriteria
numberingPlan
lengths <areaCode|exchangeCode|line|nationalNumber|
subscriberNumber>
prefixProfile <profile>
prefixProfile <profile>
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 145

CLI Reference Guide


System-Level CLI Operations

System Commands

digitProfile
dtmfTrigger
interdigitTimeout
longdigitDuration
pattern
state <disabled|enabled>
featureControlProfile
processDestinationTgrp
processDestinationTrunkContext
ipSignalingPeerGroup
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

sendRoutePSPPrecedence
silenceFactor
silenceInsertionDescriptor
t38
typeOfService
videoCalls
voiceInitialPlayoutBufferDelay
toneAndAnnouncementProfile
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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 147

CLI Reference Guide


System-Level CLI Operations

System Commands

security
cryptoSuiteProfile
ikeProtectionProfile
ipsecProtectionProfile
tlsProfile
services
classOfService
dblProfile
disconnectSignalSequenceProfile
disconnectTreatmentProfile
emergencyCallProfile
pathCheckProfile
sipArsProfile
sipSecurityProfile
signaling
XHeaderProfile
ipSignalingProfile
numberGlobalizationProfile
sctpProfile
signalingProfile
signalingQosKpiProfile
sipAdaptorProfile
sipCauseCodeMapping
sipCacProfile
system
coredumpProfile
ipPolicingAlarmProfile
overloadProfile

system
The command syntax of the objects related to the show table system
command is shown below.
> show table system
admin
announcements
baseMacAddress
congestion
coredumpList
2 148

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

coredumpSummary
cpuUtilCurrentStatistics
cpuUtilIntervalStatistics
daughterBoardStatus
dspPad
dspRes
dspStatus
ethernetPort
fanStatus
hardDiskStatus
hardDiskUsage
highAvailabilityPort
intervalStatistics
ipPolicing
jsrcServer
ledStatus
licenseInfo
licenseStatus
logicalMgmtIpInterface
logicalMgmtIpInterfaceStatus
media
mediaProfile
memoryUtilCurrentStatistics
memoryUtilIntervalStatistics
mgmtIpInterfaceGroup
mgmtStaticRoute
ntp
policyServer
powerSupplyStatus
savedConfigList
security
serverAdmin
serverSoftwareUpgradeStatus
upgrademodule.
serverStatus
softwareUpgradeStatus
syncStatus
systemCongestionCurrentStatistics
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 149

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

-------------------------------

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 151

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 153

CLI Reference Guide


System-Level CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


System Commands

System-Level CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

2 155

CLI Reference Guide


System-Level CLI Operations

2 156

System Commands

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Configure CLI Operations

CHAPTER 3

Configure CLI Operations

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 ?
Possible completions:
addressContext - Objects scoped to a specific IP addressing
domain.
global

- Global objects that are applicable Node wide

oam

- Operations and Maintenance objects.

profiles - Profiles of configuration shared by multiple


objects.
system

- System-level configuration.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

31

CLI Reference Guide


Configure CLI Operations

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
request Make system-level requests
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
top Exit to top level and optionally run command
up Exit one level of configuration

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Configure Commands

Configure CLI Operations

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

33

CLI Reference Guide


Configure CLI Operations

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
oam Operations and Maintenance objects.
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>
Possible completions:
0 - 2012-08-21 17:43:57 by admin via netconf

34

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Configure Commands

Configure CLI Operations

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
oam Operations and Maintenance objects.
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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

35

CLI Reference Guide


Configure CLI Operations

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
550-05505 Version 1 Release V03.01.00

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>
tcpPort <#>
primaryOriginHost <primary host name>
realmRoute <route_name>
appId rx
peer <name>
priority <0-100>
realm <name>
state <disabled|enabled>
secondaryOriginHost <secondary host name>
state <disabled|enabled>
transactionTimeout <500-6000 milliseconds>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

ipInterfaceGroupName

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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

1. peer name
2. realm
3. realmRoute name

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

45

CLI Reference Guide


Address Context

Diameter Node

Default values:

46

appId = rx (for PCRF interface)


state = disabled
priority = 0

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
order <priority|roundrobin>
state <disabled|enabled>
server <DSN server name>
ipAddress <ip address>
priority <0-100>
recursionDesired <false|true>
state <disabled|enabled>
weight <0-100>
type <ip|mgmt|none>
CLI syntax to configure the type of IP interfaces to be used for this DNS Group:
% set addressContext <addressContext name> dnsGroup
<dnsGroup name> type <ip|mgmt|none>
CLI syntax to configure the local DNS resource record:
% set addressContext <addressContext name> dnsGroup
<dnsGroup name> localRecord <record_name>
data <index#>
ipAddress <ip address>
priority <0-100>
state <disabled|enabled>
type a
hostName <host_Name>
order <priority|roundrobin>
state <enabled|disabled>
CLI syntax to configure the DNS server for this address context:
% set addressContext <addressContext name> dnsGroup
<dnsGroup name> server <DNS server name>
ipAddress <DNS_ipAddress>
priority <0-100>
recursionDesired <false|true>
state <disabled|enabled>
48

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
% show table/status addressContext a1 dnsGroup DNSGroup1
dnsEntryStatus
% show table/status addressContext a1 dnsGroup DNSGroup1
dnsEntryDataStatus

4 12

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
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;
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 15

CLI Reference Guide


Address Context

IP Access Control List

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IP Access Control List

Address Context

Command Parameters
TABLE 4 4

IP Access Control List Parameters

Parameter

Length/
Range

Description

Mandatory parameter descriptions


addressContext

1-23

The name of the address context. The address context is a


container of objects that correspond to a specific IP
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).

destinationIpAddress

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 17

CLI Reference Guide


Address Context

TABLE 4 4

IP Access Control List

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.

mgmtIpInterfaceGroup

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IP Access Control List

Address Context

% show addressContext default ipAccessControlList


rule 2 {
precedence

22;

protocol

any;

ipInterfaceGroup

ipInterfaceGroup1;

ipInterface

ipInterface1;

sourceIpAddress

10.32.22.145;

sourceAddressPrefixLength

1;

destinationIpAddress

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:
% show addressContext default ipAccessControlList
displaylevel 1
rule RULE1;
rule rule1;
To display the IP access control list details with display level set to 3:
% show addressContext default ipAccessControlList
displaylevel 3
rule RULE1 {
precedence 4;
}
rule rule1 {
precedence

1;

protocol

any;

sourceIpAddress

0.0.0.0;

sourceAddressPrefixLength

0;

destinationIpAddress

0.0.0.0;

destinationAddressPrefixLength 0;
sourcePort

any;

destinationPort

any;

action

accept;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 19

CLI Reference Guide


Address Context

IP Access Control List

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
ipAclRulesByPrecedence
To view statistics from System-level CLI:
> show table addressContext default ipAccessControlList
ipAclOverallStatistics
> 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
% set addressContext default ipAccessControlList rule
mgmt2_80 destinationPort 80 mgmtIpInterfaceGroup
mgmtGroup1 protocol tcp bucketSize 10 fillRate 100
precedence 201 action accept state enabled
% set addressContext default ipAccessControlList rule
mgmt2_161 destinationPort 161 mgmtIpInterfaceGroup
mgmtGroup1 protocol udp bucketSize 10 fillRate 50
precedence 202 action accept state enabled
% set addressContext default ipAccessControlList rule
mgmt2_123 sourcePort 123 mgmtIpInterfaceGroup mgmtGroup1
protocol udp bucketSize 4 fillRate 4 precedence 103 state
enabled
% set addressContext default ipAccessControlList rule
mgmt2_162 sourcePort 162 mgmtIpInterfaceGroup mgmtGroup1

4 20

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IP Access Control List

Address Context

protocol udp bucketSize 10 fillRate 10 precedence 104


state enabled
% set addressContext default ipAccessControlList rule
mgmt2_1812 sourcePort 1812 mgmtIpInterfaceGroup
mgmtGroup1 protocol udp bucketSize 4 fillRate 4
precedence 105 state enabled
% set addressContext default ipAccessControlList rule
mgmt2_2022 destinationPort 2022 mgmtIpInterfaceGroup
mgmtGroup1 protocol tcp bucketSize 10 fillRate 10
precedence 206 action accept state enabled
% set addressContext default ipAccessControlList rule
mgmt2_443 destinationPort 443 mgmtIpInterfaceGroup
mgmtGroup1 protocol tcp bucketSize 10 fillRate 100
precedence 208 action accept state enabled
% set addressContext default ipAccessControlList rule
mgmt2_2024 destinationPort 2024 mgmtIpInterfaceGroup
mgmtGroup1 protocol tcp bucketSize 250 fillRate 2500
precedence 209 action accept state enabled
% set addressContext default ipAccessControlList rule
mgmt2_1813 sourcePort 1813 mgmtIpInterfaceGroup
mgmtGroup1 protocol udp bucketSize 250 fillRate 1200
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 21

CLI Reference Guide


Address Context

IP Access Control List

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

mgmt2_161 202 udp - - mgmtGroup1 - 0.0.0.0


any
161
accept 50
10

0 0.0.0.0 0
enabled

mgmt2_162 104 udp - - mgmtGroup1 - 0.0.0.0


162
any
accept 10
10

0 0.0.0.0 0
enabled

mgmt2_443 208 tcp - - mgmtGroup1 - 0.0.0.0


any
443
accept 100
10

0 0.0.0.0 0
enabled

mgmt2_1812 105 udp - - mgmtGroup1 - 0.0.0.0


1812
any
accept 4
4

0 0.0.0.0 0
enabled

mgmt2_1813 110 udp - - mgmtGroup1 - 0.0.0.0


1813
any
accept 1200 250

0 0.0.0.0 0
enabled

mgmt2_2022 206 tcp - - mgmtGroup1 - 0.0.0.0


any
2022
accept 10
10

0 0.0.0.0 0
enabled

mgmt2_2024 209 tcp - - mgmtGroup1 - 0.0.0.0


any
2024
accept 2500 250

0 0.0.0.0 0
enabled

To view the default system IP ACL statistics: from System-level CLI


> show table addressContext default ipAccessControlList
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IP Access Control List

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 23

CLI Reference Guide


Address Context

IP Access Control List

FIGURE 4 3 Default System IP ACL Statistics

4 24

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>
ipsec <disabled|enabled>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
displaylevel <displaylevel>
action <dryup|force>
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>
state <disabled|enabled>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IP Interface Group

Address Context

Command Parameters
TABLE 4 6

IP Interface Group Parameters

Parameter

Length/
Range

Description
Mandatory parameter descriptions

addressContext

1-23

The name of the address context. The address context is a


container of objects that correspond to a specific IP Addressing
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

Non-mandatory parameter descriptions


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
displaylevel <positiveInteger | <= 64>>
ipAddress <ipAddress>
4 34

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


IPsec

Address Context

localIdentity <fqdn | ipV4Addr | ipV6Addr>


ipAddress <ipAddress>
preSharedKey <DES3 | encrypted | string>
protectionProfile <profile_name>
protocol <0 to 255>
remoteIdentity <fqdn | ipV4Addr | ipV6Addr>
% show addressContext <addressContext_name> ipsec spd
<spd_name>
displaylevel <positiveInteger | <= 64>>
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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
Addressing domain. Must be 1-23 characters.
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
ipAddress Enter the IPv6 address.

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).
ipAddress Enter the IPv4 address.
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).
ipAddress Enter the IPv6 address.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
Addressing domain. Must be 1-23 characters.

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

To display different levels of output information in show


commands.

4 38

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

Link Detection Group

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
% set addressContext <addressContext_name>
linkDetectionGroup <linkdetectionGroup_name>
ceName <ceName_name>
linkMonitor <linkMonitor_name>
reattemptTimer <300-10000>
responseTimer <500-10000>
retries <1-10>
state <disabled|enabled>
threshold <0-10>
type <ip|mgmt>
verifyTimer <1000-60000>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 41

CLI Reference Guide


Address Context

Link Detection Group

% show addressContext <addressContext_name>


linkDetectionGroup <linkDetectiongroup_name>
displaylevel <displaylevel>
ceName <ceName_name>
linkMonitor <linkMonitor>
reattemptTimer <300-10000>
responseTimer <500-10000>
retries <1-10>
state <disabled|enabled>
threshold <0-10>
type <ip|mgmt>
verifyTimer <1000-60000>
% delete addressContext <addressContext_name>
linkDetectionGroup <linkDetectionGroup_name>

4 42

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

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

To display different levels of output information in show


commands.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 43

CLI Reference Guide


Address Context

Link Detection Group

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

sbx48.eng.sonusnet.com;

type

ip;

threshold

1;

verifyTimer

1000;

responseTimer

500;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

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

sbx39.eng.sonusnet.com;

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 45

CLI Reference Guide


Address Context

Link Detection Group

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

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.
% set addressContext <addressContext_name>
linkDetectionGroup <LDG_name> linkMonitor <name>
destination <IP Address>
state <disabled|enabled>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 47

CLI Reference Guide


Address Context

Link Detection Group

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.
% set addressContext <addressContext_name>
linkDetectionGroup <LDG_name> linkMonitor <name>
interface <interface_name>
interfaceGroup <interfaceGroup_name>
reattemptTimer <300-10000>
responseTimer <500-10000>
retries <1-10>
verifyTimer <1000-60000>
% show addressContext <addressContext_name>
linkDetectionGroup <LDG_name> linkMonitor <name>
displaylevel <displaylevel>
destination <IP address>
interface <interface_name>
interfaceGroup <interfaceGroup_name>
reattemptTimer <300-10000>
responseTimer <500-10000>
retries <1-10>
state <disabled|enabled>
verifyTimer <1000-60000>
% delete addressContext <addressContext_name>
linkDetectionGroup <LDG_name> linkMonitor <name>

4 48

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

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.


enabled turned on and active
disabled (default) not in use

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
LinkDetectionGroup is 1000 (milliseconds).

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
LinkDetectionGroup is 15000 (milliseconds).

displaylevel

1-64

To display different levels of output information in show


commands.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 49

CLI Reference Guide


Address Context

Link Detection Group

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
% set addressContext default ipInterfaceGroup VLAN50
ipInterface pkt1.50 ceName fiji01 portName pkt1 ipAddress
10.151.50.129 prefix 24 vlanTag 50 altIpAddress
2050:FEED:DEAD:BEEF:10:151:50:129 altPrefix 64
% set addressContext default ipInterfaceGroup VLAN51
ipInterface pkt0.51 ceName fiji01 portName pkt0 ipAddress
10.151.51.128 prefix 24 vlanTag 51 altIpAddress
2051:FEED:DEAD:BEEF:10:151:51:128 altPrefix 64
% set addressContext default ipInterfaceGroup VLAN51
ipInterface pkt1.51 ceName fiji01 portName pkt1 ipAddress
10.151.51.129 prefix 24 vlanTag 51 altIpAddress
2051:FEED:DEAD:BEEF:10:151:51:129 altPrefix 64
% set addressContext default ipInterfaceGroup VLAN52
ipInterface pkt2.52 ceName fiji01 portName pkt2 ipAddress
10.151.52.128 prefix 24 vlanTag 52 altIpAddress
2052:FEED:DEAD:BEEF:10:151:52:128 altPrefix 64
% set addressContext default ipInterfaceGroup VLAN52
ipInterface pkt3.52 ceName fiji01 portName pkt3 ipAddress
4 50

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

10.151.52.129 prefix 24 vlanTag 52 altIpAddress


2052:FEED:DEAD:BEEF:10:151:52:129 altPrefix 64
% commit
% set addressContext default ipInterfaceGroup VLAN50
ipInterface pkt0.50 state enable mode inservice
% set addressContext default ipInterfaceGroup VLAN50
ipInterface pkt1.50 state enable mode inservice
% set addressContext default ipInterfaceGroup VLAN51
ipInterface pkt0.51 state enable mode inservice
% set addressContext default ipInterfaceGroup VLAN51
ipInterface pkt1.51 state enable mode inservice
% set addressContext default ipInterfaceGroup VLAN52
ipInterface pkt2.52 state enable mode inservice
% set addressContext default ipInterfaceGroup VLAN52
ipInterface pkt3.52 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
% set addressContext default linkDetectionGroup a1_mgmt_ldg
threshold 2 retries 2

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 51

CLI Reference Guide


Address Context

Link Detection Group

% set addressContext default linkDetectionGroup a1_mgmt_ldg


verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt1_lm destination 10.151.41.15
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt1_lm interfaceGroup mgmtGroup interface
mgmtIntf1
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt1_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt2_lm destination 10.151.42.15
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt2_lm interfaceGroup mgmtGroup interface
mgmtIntf2
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt2_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_mgmt_ldg
ceName andros02 type mgmt
% set addressContext default linkDetectionGroup a2_mgmt_ldg
threshold 2 retries 2
% set addressContext default linkDetectionGroup a2_mgmt_ldg
verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt3_lm destination 10.151.41.15
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt3_lm interfaceGroup mgmtGroup interface
mgmtIntf3
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt3_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
4 52

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

% set addressContext default linkDetectionGroup a2_mgmt_ldg


linkMonitor mgmt4_lm destination 10.151.42.15
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt4_lm interfaceGroup mgmtGroup interface
mgmtIntf4
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt4_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% commit
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt1_lm state enabled
% set addressContext default linkDetectionGroup a1_mgmt_ldg
linkMonitor mgmt2_lm state enabled
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt3_lm state enabled
% set addressContext default linkDetectionGroup a2_mgmt_ldg
linkMonitor mgmt4_lm state enabled
% commit
% set addressContext default linkDetectionGroup a1_mgmt_ldg
state enabled
% set addressContext default linkDetectionGroup a2_mgmt_ldg
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 53

CLI Reference Guide


Address Context

Link Detection Group

% set addressContext default linkDetectionGroup a1_50pkt_ldg


threshold 1 retries 2
% set addressContext default linkDetectionGroup a1_50pkt_ldg
verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt0.50_lm destination 10.151.50.38
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt0.50_lm interfaceGroup VLAN50 interface
pkt0.50
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt0.50_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt1.50_lm destination 10.151.50.38
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt1.50_lm interfaceGroup VLAN50 interface
pkt1.50
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt1.50_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_50pkt_ldg
ceName andros02 type ip
% set addressContext default linkDetectionGroup a2_50pkt_ldg
threshold 1 retries 2
% set addressContext default linkDetectionGroup a2_50pkt_ldg
verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt0.50_lm destination 10.151.50.38
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt0.50_lm interfaceGroup VLAN50 interface
pkt0.50

4 54

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

% set addressContext default linkDetectionGroup a2_50pkt_ldg


linkMonitor pkt0.50_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt1.50_lm destination 10.151.50.38
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt1.50_lm interfaceGroup VLAN50 interface
pkt1.50
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt1.50_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% commit
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt0.50_lm state enabled
% set addressContext default linkDetectionGroup a1_50pkt_ldg
linkMonitor pkt1.50_lm state enabled
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt0.50_lm state enabled
% set addressContext default linkDetectionGroup a2_50pkt_ldg
linkMonitor pkt1.50_lm state enabled
% commit
% set addressContext default linkDetectionGroup a1_50pkt_ldg
state enabled
% set addressContext default linkDetectionGroup a2_50pkt_ldg
state enabled
% commit

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 55

CLI Reference Guide


Address Context

Link Detection Group

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
% set addressContext default linkDetectionGroup a1_51pkt_ldg
ceName andros01 type ip
% set addressContext default linkDetectionGroup a1_51pkt_ldg
threshold 1 retries 2
% set addressContext default linkDetectionGroup a1_51pkt_ldg
verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt0.51_lm destination 10.151.51.38
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt0.51_lm interfaceGroup VLAN51 interface
pkt0.51
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt0.51_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt1.51_lm destination 10.151.51.38
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt1.51_lm interfaceGroup VLAN51 interface
pkt1.51
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt1.51_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_51pkt_ldg
ceName andros02 type ip
% set addressContext default linkDetectionGroup a2_51pkt_ldg
threshold 1 retries 2

4 56

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

% set addressContext default linkDetectionGroup a2_51pkt_ldg


verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt0.51_lm destination 10.151.51.38
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt0.51_lm interfaceGroup VLAN51 interface
pkt0.51
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt0.51_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt1.51_lm destination 10.151.51.38
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt1.51_lm interfaceGroup VLAN51 interface
pkt1.51
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt1.51_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% commit
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt0.51_lm state enabled
% set addressContext default linkDetectionGroup a1_51pkt_ldg
linkMonitor pkt1.51_lm state enabled
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt0.51_lm state enabled
% set addressContext default linkDetectionGroup a2_51pkt_ldg
linkMonitor pkt1.51_lm state enabled
% commit
% set addressContext default linkDetectionGroup a1_51pkt_ldg
state enabled
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 57

CLI Reference Guide


Address Context

Link Detection Group

% set addressContext default linkDetectionGroup a2_51pkt_ldg


state enabled
% commit
To configure link detection on the 52-net:
% set addressContext default linkDetectionGroup a1_52pkt_ldg
ceName andros01 type ip
% set addressContext default linkDetectionGroup a1_52pkt_ldg
threshold 1 retries 2
% set addressContext default linkDetectionGroup a1_52pkt_ldg
verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt2.52_lm destination 10.151.52.38
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt2.52_lm interfaceGroup VLAN52 interface
pkt2.52
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt2.52_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt3.52_lm destination 10.151.52.38
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt3.52_lm interfaceGroup VLAN52 interface
pkt3.52
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt3.52_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_52pkt_ldg
ceName andros02 type ip
% set addressContext default linkDetectionGroup a2_52pkt_ldg
threshold 1 retries 2
4 58

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Link Detection Group

Address Context

% set addressContext default linkDetectionGroup a2_52pkt_ldg


verifyTimer 1000 responseTimer 500 reattemptTimer 300
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt2.52_lm destination 10.151.52.38
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt2.52_lm interfaceGroup VLAN52 interface
pkt2.52
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt2.52_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt3.52_lm destination 10.151.52.38
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt3.52_lm interfaceGroup VLAN52 interface
pkt3.52
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt3.52_lm verifyTimer 1000 responseTimer 500
reattemptTimer 300
% commit
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt2.52_lm state enabled
% set addressContext default linkDetectionGroup a1_52pkt_ldg
linkMonitor pkt3.52_lm state enabled
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt2.52_lm state enabled
% set addressContext default linkDetectionGroup a2_52pkt_ldg
linkMonitor pkt3.52_lm state enabled
% commit

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 59

CLI Reference Guide


Address Context

Link Detection Group

% set addressContext default linkDetectionGroup a1_52pkt_ldg


state enabled
% set addressContext default linkDetectionGroup a2_52pkt_ldg
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


NAT Direct Media Group

Address Context

NAT Direct Media Group

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 61

CLI Reference Guide


Address Context

NAT Direct Media Group

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
displaylevel <displaylevel>
preference <preferenceNumber>
% delete addressContext <addressContext> staticRoute
<IpAddress>

Command Parameters
TABLE 4 14 Static Route Parameters
Parameter

Length/
Range Description

addressContext

1-23

4 64

The name of the address context. The address context is a


container of objects that correspond to a specific IP Addressing
domain.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

<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

To display different levels of output information in show


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;
}
staticRoute 10.34.9.70 32 10.34.25.1 LIF1 lif_eth2 {
preference 10;
}
staticRoute 10.34.9.95 32 10.34.26.1 LIF2 lif_eth3 {
preference 10;
}
staticRoute 10.34.13.194 32 10.34.25.1 LIF1 lif_eth2 {
preference 1;
}
staticRoute 10.34.13.195 32 10.34.26.1 LIF2 lif_eth3 {
preference 10;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 67

CLI Reference Guide


Address Context

Zone

// Gateway Signaling Port mandatory parameters:


ipInterfaceGroupName <name>
portNumber <#>
// Gateway Signaling Port non-mandatory parameters:
ipAddress <ip address>
mode <outOfService|inService>
role <primary|secondary>
state <disabled|enabled>
// 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>
mode <inService|outOfService>
state <disabled|enabled>
// 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>
ipInterfaceGroupName <name>
mode <inService|outOfService>
portNumber <1-65535>
state <disabled|enabled>
// H.323 Signaling Port non-mandatory parameters:
dryUpTimeout <0-1440>
h245IpAddress <ip address>
// H.323 Trunk Group mandatory parameters:
h323TrunkGroup <TRUNKGROUP_NAME>

4 68

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

action <dryUp|force|undefined>
dryUpTimeout <0-1440>
ingressIpPrefix <ip_address prefix_length>
mode <outOfService|inService>
sendingCompleteEnbloc <disabled|enabled>
state <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>
ipAddress <ip address>
ipPort <0-65535>
pathCheck
policy
sip
surrogateRegistration
// SIP Signaling Port mandatory parameters:
<index #>
dscpValue <0-63>
ipInterfaceGroupName <name>
portNumber <1-65535>
recorder <disabled|enabled>
sctpProfileName <name>
state <disabled|enabled>
tcpConnectTimeout <0-180>
tlsProfileName <name>
transportProtocolsAllowed <protocol list>
// SIP Signaling Port non-mandatory parameters:

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 69

CLI Reference Guide


Address Context

Zone

sipSigPort <sipSigPort>
ipAddressV4
ipAddressV6
mode <outOfService|inService>
// SIP Trunk Group mandatory parameters:
<TG_NAME>
action <dryUp|force>
downstreamForkingSupport <disabled|enabled>
dryUpTimeout <1-1440>
ingressIpPrefix <ip_address prefix_length>
mode <outOfService|inService>
recordingDNpreference <preference>
state <disabled|enabled>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
callLimit <0-2147483647, or unlimited>
callRateMax <1-100, or unlimited>
emergencyOversubscription <0-1000>
registerBurstMax <1-200, or unlimited>
registerRateMax <1-100, or unlimited>
emergencyOversubscription <0-1000>
ingress
callBurstMax <1-200, or unlimited>
callLimit <0-2147483647, or unlimited>
callRateMax <1-100, or unlimited>
emergencyOversubscription <0-1000>
packetRateMax <1-65535, or unlimited>
registerBurstMax <1-200, or unlimited>
registerRateMax <1-100, or unlimited>
registrationLimit <0-2147483647, or unlimited>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
other must also be assigned a value.

4 72

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
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)
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
other must also be assigned a value.

registrationLimit Number of registrations allowed on this zone.


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

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.

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
% set addressContext <addressContext_name> zone <zone_name>
gwSigPort <#>
ipAddress <IP address>
ipInterfaceGroupName <name>
mode <inService|outOfService>
portNumber <#>
role <primary|secondary>
state <disabled|enabled>

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 75

CLI Reference Guide


Address Context

Zone

gwTrunkGroup
Use this object to configure gateway trunk group parameters
NOTE

As a best practice, always use UPPERCASE for trunk group names.

Command Syntax
% set addressContext <name> zone <name> gwTrunkGroup <name>
accMc1Percent <0-100>
accMc2Percent <0-100>
accTimer <0-10>
action <dryUp|force|undefined>
callReservation
inbound <0-100>
incomingCallMinimum <0-128>
outgoingCallMinimum <0-100>
priorityCallMinimum <0-100>
silc
MC1Percent <0-100>
MC2Percent <0-100>
state <disabled|enabled>
state <disabled|enabled>
dryUpTimeout <1-1440>
ingressIpPrefix <IP address>
media
directMediaAllowed <disabled|enabled>
mediaIpInterfaceGroupName <name>
sourceAddressFiltering <disabled|enabled>
mode <inService|outOfService>
packetOutage
bandwidthLimitReduction <0-100>
detectionInterval <5-1440>
detectionState <disabled|enabled>
minimumCalls <0-65535>
minimumDuration <0-65535>
state <disabled|enabled>

4 76

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
NOTE: Zone name is unique across all address contexts.

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).
(range: 0-100 percent / default = 70).
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
allowed when reservations are enabled for this gateway trunk
group. (range: 0-100 / default = 10).
priorityCallMinimum Minimum number of priority calls
allowed when reservations are enabled for this gateway trunk
group. (range: 0-100 / default =1).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
(range: 0-100 percent / default = 75).
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
outOfService (default)
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 79

CLI Reference Guide


Address Context

Zone

h323SigPort
Command Syntax
% set addressContext <name> zone <name> h323SigPort <#>
action <dryup|force>
dryUpTimeout <0-1440>
dscpValue <#>
h225IpAddress <IPv4 address>
h245IpAddress <IPv4 address>
ipInterfaceGroupName <name>
mode <inService|outOfService>
portNumber <#>
state <disabled|enabled>

Command Parameters
TABLE 4 19 Zone H.323 Signaling Port 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.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

As a best practice, always use UPPERCASE for trunk group names.

Command Syntax
% set addressContext <name> zone <name> h323TrunkGroup <TG
name>
action <dryUp|force|undefined>
cac
bandwidthLimit <0-2147483647, or unlimited>
bandwidthLimitThreshold <0-100>
callLimit <0-2147483647, or unlimited>
callLimitThreshold <0-100>
egress
callBurstMax <1-200>
callLimit <0-2147483647, or unlimited>
callRateMax <1-100>
ingress
callBurstMax <1-200>
callRateMax <1-100>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 81

CLI Reference Guide


Address Context

Zone

callReservationgroup
inbound <1-100>
incomingCallMinimum <0-128>
outgoingCallMinimum <0-100>
priorityCallMinimum <0-100>
silc
MC1Percent <0-100>
MC2Percent <0-100>
state <disabled|enabled>
state <disabled|enabled>
callRouting
ansSupervisionTimeout <0-1000>
crankBackProfile <name>
respectBearerCapability <disabled|enabled>
dryUpTimeout <1-1440>
ingressIpPrefix <IP address>
media
directMediaAllowed <disabled|enabled>
directMediaGroupId <#>
mediaIpInterfaceGroupName <name>
preAllocateResPad <disabled|enabled>
sourceAddressFiltering <disabled|enabled>
mode <inService|outOfService>
packetOutage
bandwidthLimitReduction <0-100>
detectionInterval <5-1440>
detectionState <disabled|enabled>
minimumCalls <0-65535>
minimumDuration <0-65535>
parentSharedCacLimitsPoolName <name>
policy
callRouting elementRoutingPriority <ERP profile name>
carrier <serving carrier code>
country <country code>
digitParameterHandling
egressDmPmRule <rule>
ingressDmPmRule <rule>
numberingPlan <numbering plan>
4 82

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>

Command Parameters

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 83

CLI Reference Guide


Address Context

Zone

TABLE 4 20 Zone H.323 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.
NOTE: Zone name is unique across all address contexts.

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).
(range: 0-2147483647, or unlimited / default is unlimited).
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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 /
default is 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
unlimited; however, if you assign a value to one parameter, the
other must also be assigned a value.

ingress Specifies the ingress-specific call admission control


configuration. Specify the following ingress parameters:
callBurstMax Maximum allowed burst (above the allowed
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).
NOTE: You can set both callBurstMax and CallRateMax as
unlimited; however, if you assign a value to one parameter, the
other must also be assigned a value.

callReservation Parameters for reserving a portion of the


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).
incomingCallMinimum Minimum number of incoming call
allowed when reservations are enabled for this trunk group. Enter
value in range of 0-128. Default is 1.
outgoingCallMinimum Minimum percent of outgoing call
allowed when reservations are enabled for this trunk group. Enter
value in range of 0-100. Default is 10.
priorityCallMinimum Minimum number of priority call
allowed when reservations are enabled for this trunk group. Enter
value in range of 0-100. Default is 1.
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 85

CLI Reference Guide


Address Context

Zone

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


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.
- disabled (default)
- enabled
dryUpTimeout Timeout value (in minutes) for the dry up action.
(range: 1-1440 / default = 5).
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.
- disabled (default)
- 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.
- disabled (default)
- enabled

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

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


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
outOfService (default)
packetOutage Packet outage detection parameters for this H.323
trunk group.
bandwidthLimitReduction Amount to reduce the bandwidth
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.
- disabled (default)
- 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 87

CLI Reference Guide


Address Context

Zone

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


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

4 88

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

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


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.
(range: 0-70 / default = 40).
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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 89

CLI Reference Guide


Address Context

Zone

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


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.
(range: 0-100 / default = 50).
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
which all calls are dropped on specified peer/trunk group. (range:
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

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


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

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.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 91

CLI Reference Guide


Address Context

Zone

ipPeer
Command Syntax
% set addressContext <name> zone <name> ipPeer <peer name>
defaultForIp <false|true>
ipAddress <IP address>
ipPort <0-65535>
pathCheck
profile <name>
state <disabled|enabled>
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.>
state <disabled|enabled>
userPart <user part name>

Command Parameters
TABLE 4 22 Zone IP Peer 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.

4 92

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
(range: 0-65535 / default = 0)
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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 93

CLI Reference Guide


Address Context

Zone

TABLE 4 22 Zone IP Peer Parameters (Continued)


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 22 Zone IP Peer Parameters (Continued)


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:
% set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1
ipPeer SURR_PEER1 surrogateRegistration state enabled
% commit
Disable surrogate registration:
% set addressContext PKT0_ADDR_CONTEXT_1 zone PKT0_TG1
ipPeer SURR_PEER1 surrogateRegistration state disabled
% commit

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
NOTE: Zone name is unique across all address contexts.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

Command Parameters
TABLE 4 24 Zone Remote Device Type 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.

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>
ipInterfaceGroupName <name>
mode <inService|outOfService>
portNumber <#>
recorder <disabled|enabled>
sctpProfileName <name>
state <disabled|enabled>
tcpConnectTimeout <0-180>
tlsProfileName <name>
transportProtocolsAllowed <sip-sctp|sip-tcp|sip-tlstcp|sip-udp>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

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.

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.
(range: 0-180 / default = 5).
tlsProfileName TLS Profile name used by this Signaling Port.

4 98

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

As a best practice, always use UPPERCASE for trunk group names.

Command Syntax
% set addressContext <name> zone <name> sipTrunkGroup <name>
action <dryUp|force>
cac
bandwidthLimit <0-2147483647>
bandwidthLimitThreshold <0-100>
callLimit <0-2147483647>
callLimitThreshold <0-100>
egress
emergencyOversubscription <0-1000>
estimatedChildRegistrations <1-256>
ingress
registeredEndpointCacProfile <profile name>
registrationLimit
subscriptionLimit
callReservation
inbound <0-100>
incomingCallMinimum <0-128>
outgoingCallMinimum <0-100>
priorityCallMinimum <0-100>
silc
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 99

CLI Reference Guide


Address Context

Zone

MC1Percent <0-100>
MC2Percent <0-100>
state <disabled|enabled>
state <disabled|enabled>
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>
dryUpTimeout <1-1440>
ingressIpPrefix <IP address>
media
comediaConnectionRole <active|none|passive>
dataPathModePassthru <disabled|enabled>
directMediaAllowed <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>
sourceAddressFiltering <disabled|enabled>
4 100

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

tmr64K <disabled|enabled>
mode <inService|outOfService>
packetOutage
bandwidthLimitReduction <0-100>
detectionInterval <5/1440>
detectionState <disabled|enabled>
minimumCalls <0-65535>
minimumDuration <0-65535>
parentSharedCacLimitsPoolName <name>
policy
callRouting elementRoutingPriority <ERP profile name>
carrier <serving carrier code>
country <country code>
digitParameterHandling
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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

timers
ocsDialogTimer <# seconds>
sctpRetransmitTimer <# seconds>
sessionKeepalive <# seconds>
sessionMinSE <# seconds>
sessionTerminationDeltaTime <# seconds>
suspendResumeTimer
state <disabled|enabled>
type <both|networkTypeOnly|userTypeOnly>
value <#>
t1 <# milliseconds>
t2 <# milliseconds>
tcpRetransmitTimer <# seconds>
transportPreference
preference1 <none|sctp|tcp|tls-tcp|udp>
preference2 <none|sctp|tcp|tls-tcp|udp>
preference3 <none|sctp|tcp|tls-tcp|udp>
preference4 <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>
state <disabled|enabled>
ucidSupport <none|passthruOrGenerate>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

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.

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).
(range: 0-2147483647, or unlimited / default is unlimited).
bandwidthLimitThreshold Bandwidth utilization notification
threshold as a percentage. (range: 0-100 / default = 0)
callLimit Total number of concurrent calls (either ingress or
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)
callLimit Total number of concurrent calls (either ingress or
egress) allowed on egress. (range: 0-2147483647, or unlimited /
default is unlimited).
callRateMax Maximum sustained egress call rate allowed in
calls per second. (range: 1-100, or unlimited / default is
unlimited).

4 106

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


Parameter
sipTrunkGroup
(continued)

Length/
Range Description
N/A

NOTE: You can set both callBurstMax and CallRateMax 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) 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:
1-1000, or unlimited / default is unlimited)
registerRateMax Maximum sustained egress rate
(registrations per second) of initial SIP registrations allowed.
(range: 1-1000, 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 other must also be assigned a value.

subscribeBurstMax Maximum allowed burst (above the


allowed sustained rate) for egress initial SIP subscribe request.
(range: 1-1000, or unlimited / default is unlimited)
subscribeRateMax Maximum sustained egress rate
(subscribes per second) of initial SIP subscribe request. (range:
1-1000, or unlimited / default is unlimited)
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.
callBurstMax Maximum allowed burst (above the allowed
sustained rate) for ingress calls in calls per second.
(range: 1-200, or unlimited / default is unlimited).
callLimit Total number of concurrent calls allowed on
ingress. (range: 0-2147483647, or unlimited / default is
unlimited).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 107

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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).
NOTE: You can set both callBurstMax and CallRateMax 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) 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).
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.

4 108

subscribeBurstMax Maximum allowed burst (above the


allowed sustained rate) for ingress initial SIP subscribe request.
(range: 1-1000, or unlimited / default is unlimited)
subscribeRateMax Maximum sustained ingress rate
(subscribes per second) of initial SIP subscribe request. (range:
1-1000, or unlimited / default is unlimited)
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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


Parameter
sipTrunkGroup
(continued)

Length/
Range Description
N/A

callReservation Parameters for reserving a portion of the


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.
(range: 0-100 / default = 0).
incomingCallMinimum Minimum number of incoming call
allowed when reservations are enabled. (range: 0-128 / default = 1)
outgoingCallMinimum Minimum percent of outgoing call
allowed when reservations are enabled.
(range: 0-100 / default = 10)
priorityCallMinimum Minimum number of priority call allowed
when reservations are enabled.
(range: 0-100 / default = 1).
silc Specifies the SILC traffic control configuration.
MC1Percent Specifies the percentage of calls to accept when
the machine congestion level is 1.
(range: 0-100 / default = 75).
MC2Percent Specifies the percentage of calls to accept when
the machine congestion level is 2.
(range: 0-100 / default = 25).
state Use flag to enable/disable SILC traffic control.
- disabled (default)
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 109

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 111

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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.
- disabled (default)
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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
outOfService (default)
packetOutage Specifies the packet outage detection parameters
for this SIP trunk group.
bandwidthLimitReduction Amount to reduce the bandwidth
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 113

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- 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 and
Parameter Manipulation profile applied at the ingress.
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
packetServiceProfile
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.
(range: 0-70 / default = 40).
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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 115

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
(range: 0-100 / default = 50).
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
which all calls are dropped on specified peer/trunk group. (range:
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 117

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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.
- disabled (default)
- 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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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.
- disabled (default)
- enabled
TCPFallback Use this control to configure TCP Fallback
settings.
maxMTUSupportedOverUDPControl Maximum MTU Size
accepted over UDP.
- disabled (default)
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 119

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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)
will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
rpiForCallingParty If enabled, the RPI header (if present)
will be accepted to form the Calling-Party-ID.
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 121

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
- disabled (default)
- 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
processed or rejected with 405.
- allow (default)
- reject
publish Determines if PUBLISH request is accepted and
processed or rejected with 405.
- allow (default)
- reject
refer Determines if REFER request is accepted and
processed or rejected with 405.
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 123

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


Parameter
sipTrunkGroup
(continued)

Length/
Range Description
N/A

update Determines whether UPDATE request is accepted and


processed or rejected with 405.
- 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.
- disabled (default)
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
(range: 0-12 / default = 3).
cancel Maximum number of retransmissions for SIP CANCEL
request. (range: 0-12 / default = 3).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 125

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


Parameter
sipTrunkGroup
(continued)

Length/
Range Description
N/A

4 126

general Maximum number of retransmissions for generic SIP


request. (range: 4-12 / default = 7).
invite Maximum number of retransmissions for SIP INVITE
request. (range: 0-6 / default = 6).
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.
- disabled (default)
- 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).

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.
(range: 1-720 / default = 30).
- 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 127

CLI Reference Guide


Address Context

Zone

TABLE 4 26 Zone SIP Trunk Group Parameters (Continued)


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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 {
ipInterfaceGroupName

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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 {
ipAddress 10.34.9.70;
ipPort

7056;

state

enabled;

policy {
description

"";

sip {
fqdn "";
}
packetServiceProfileId "";
ipSignalingProfileId

"";

}
}
sipSigPort 1 {
ipInterfaceGroupName

LIF1;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

"";

localizationVariant northAmerica;
digitParameterHandling {
numberingPlan

NANP_ACCESS;

ingressDmPmRule "";
egressDmPmRule

"";

}
callRouting {
elementRoutingPriority DEFAULT_IP;
}
media {
packetServiceProfile DEFAULT;
}
services {
classOfService DEFAULT_IP;
}
signaling {
ipSignalingProfile DEFAULT_SIP;
}
}
signaling {
methods {
notify allow;
}
}
media {

4 132

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 133

CLI Reference Guide


Address Context

Zone

}
sipSigPort 1 {
ipInterfaceGroupName

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 135

CLI Reference Guide


Address Context

Zone

sendingCompleteEnbloc disabled;
policy {
carrier

0000;

country

1;

localizationVariant northAmerica;
digitParameterHandling {
numberingPlan

NANP_ACCESS;

ingressDmPmRule "";
egressDmPmRule

"";

}
callRouting {
elementRoutingPriority DEFAULT_IP;
}
media {
packetServiceProfile DEFAULT;
}
services {
classOfService DEFAULT_IP;
}
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;
550-05505 Version 1 Release V03.01.00

2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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 {
ipInterfaceGroupName

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
sipSigPortStatistics 1 {
callRate

0;

origCalls 5864747;
termCalls 9410868;
txPdus

55245380;

rxPdus

45825318;

txBytes

26211787697;

rxBytes

18580071475;

inRegs

0;

outRegs

0;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
% set addressContext ADDR_CONTEXT_1 zone ZONE_IAD
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:
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 1 type message
# configure the message criteria
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 1 type message message messageTypes all
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 1 type message message methodType invite
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 2 type messageBody
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 2 type messageBody messageBody condition regexmatch regexp numMatch match string "c=IN IP4"
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
criterion 2 type messageBody messageBody messageBodyType
all
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 1 type variable

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

4 141

CLI Reference Guide


Address Context

Zone

% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1


action 1 operation store
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 1 operation store to type variable variableValue
var1
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 1 from type value value "c=IN IP4 "
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 2 type variable operation append
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 2 from type globalVariable globalVariableValue
srcipaddr
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 2 to type variable variableValue var1
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 3 type messageBody
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 3 operation regsub
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 3 regexp string "c=IN IP4
(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})"
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
action 3 from type variable variableValue var1
% set profiles signaling sipAdaptorProfile CHANGEIP1 rule 1
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:


% set addressContext default zone EXTERNAL sipTrunkGroup
EXT_NETWORK services natTraversal signalingNat enabled

2. Enable NAT traversal for Media:


4 142

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Zone

Address Context

% set addressContext default zone EXTERNAL sipTrunkGroup


EXT_NETWORK services natTraversal mediaNat enabled

3. Configure udpKeepaliveTimer:
% set addressContext default zone EXTERNAL sipTrunkGroup
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:
% set addressContext default zone EXTERNAL sipTrunkGroup
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
% set addressContext ADDR_CONTEXT_1 zone ZONE_IAD
sipTrunkGroup TG_IAD media directMediaAllowed enabled
% set addressContext ADDR_CONTEXT_1 zone ZONE_AS
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00

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
parentSharedCacLimitsPoolName
% commit
% delete global cac sharedCacLimitsPool CAC0
% commit

52

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


CAC

Global

Scenario2:
% delete global cac sharedCacLimitsPool CAC0
parentSharedCacLimitsPoolName
% 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>
bandwidthLimitThreshold <0-100>
callLimit <0-2000000000, unlimited>
callLimitThreshold <0-100>
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>
emergencyOversubscription <1-1000>
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>
parentSharedCacLimitsPoolName <name>
registrationLimit <0-2000000000, unlimited>
subscriptionLimit <0-2000000000, unlimited>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
(range: 1-2000, or unlimited / default is unlimited)
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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)
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. (range: 1-2000, or unlimited /
default is unlimited)
subscribeRateMax Maximum sustained egress
rate of initial SIP SUBSCRIBE request allowed in
subscribes/second. (range: 1-2000, or unlimited /
default is 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 {
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

55

CLI Reference Guide


Global

CAC

callBurstMax 50;
}
}

56

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
displaylevel <displaylevel>
none <none>
trunkGroup <trunkGroup>
% show global callRouting routingLabel <routingLabel>

58

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
internationalOperator
internationalType
ipVpn
localOperator
longDistanceOperator
nationalOperator
nationalType
noDigits
otherCarrierChosen
private
serviceAccessCode
subscriberOperator
subscriberType
test
tollFree

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Call Routing

TABLE 5 2

Global

Global Call Routing Parameters (Continued)

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
internationalOperator
internationalRestricted
national
nationalNotRestricted
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
noNumberOperatorRequested

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

5 11

CLI Reference Guide


Global

TABLE 5 2

Call Routing

Global Call Routing Parameters (Continued)

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Call Routing

TABLE 5 2

Global

Global Call Routing Parameters (Continued)

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

5 13

CLI Reference Guide


Global

TABLE 5 2

Call Routing

Global Call Routing Parameters (Continued)

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

To display different levels of output information in show


commands.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

5 15

CLI Reference Guide


Global

Call Routing

script

"";

action

routes;

routingLabelRoute 1;
}
routingLabel TO_TG_SIPART_IAD {
overflowNumber

"";

overflowNOA

none;

overflowNPI

none;

routePrioritizationType sequence;
script

"";

action

routes;

routingLabelRoute 1;
}
To display call routing label details:
% show global callRouting routingLabel
routingLabel REHL1_1 {
overflowNumber

"";

overflowNOA

none;

overflowNPI

none;

routePrioritizationType sequence;
script

"";

action

routes;

routingLabelRoute 1 {
trunkGroup REHL_1;
ipPeer

REHL_1;

proportion 0;
inService

inService;

testing

normal;

}
}

5 16

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
% set global callTrace callFilter <filterName>
mediaPacketCapture enable
% set global callTrace callFilter <filterName>
callDetailCapture disable
% set global callTrace callFilter <filterName>
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

Mandatory parameter descriptions


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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Call Trace

TABLE 5 4
Parameter

Global

Global Call Trace Call Filter Parameters (Continued)


Length/
Range

Description

Non-mandatory parameter descriptions


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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

To display different levels of output information in show commands.

Command Example
To display the configuration of all carrier parameters:
% show global carrier
carrier 0000 {
services {
classOfService "";
}
5 24

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Carrier

Global

}
carrier 333 {
services {
classOfService DEFAULT_IP;
}
}
carrier 444 {
services {
classOfService DEFAULT_IP;
}
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
displaylevel <displaylevel>
% delete global country <countrycode>

5 26

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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.
disabled (default) not in use
enabled turned on and active
To display different levels of output information in show
commands.

Command Example
To display the current list of country codes:
% show global country
1

A unique identifier for the Country Code.

20

A unique identifier for the Country Code.

27

A unique identifier for the Country Code.

30

A unique identifier for the Country Code.

31

- A unique identifier for the Country Code.

32

- A unique identifier for the Country Code.

33

- A unique identifier for the Country Code.

34

- A unique identifier for the Country Code.

36

- A unique identifier for the Country Code.

39

- A unique identifier for the Country Code.

......................
To view the config. details of a specific country code:
admin@Hackos% show global country 1
listOfNumberOfDigitsToMatch {
called

10,6,3,0;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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_#>
state <disabled|enabled>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
state <disabled|enabled>

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

To display different levels of output information in show commands.

Command Example
To display the NPA/Nxx configurations:
% show global npaNxx
npaNxx National2 {
portedFlag enable;
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
description <description>
majorVersion <0-999>
minorVersion <0-999>
% show global script <script>
description <description>
majorVersion <0-999>
minorVersion <0-999>
displaylevel <displaylevel>
% delete global script <script>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

To display different levels of output information in show commands.

Command Example
To display the script configuration:
% show global script
script BLOCKING {
description

"";

majorVersion 0;
minorVersion 1;
}
script DEFAULT_TERMINATING {
description

"";

majorVersion 0;
minorVersion 1;
}
script NO_ROUTES_FOUND {
description

"";

majorVersion 2;
minorVersion 1;

5 36

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
displaylevel <displaylevel>
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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
portNumber <0-65535>
enumDomain <domain_name>
ipAddress1 <1st ENUM ip_address>
ipAddress2 <2nd ENUM ip_address>
ipAddress3 <3rd EMNUM ip_address>
enumService <name>
criteria triggerCriteria <criteria>
defaultTreatment <applyFinalTreatment|routeAsDialed>

5 38

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
criteria triggerCriteria <criteria>
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
portNumber <0-65535>

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)
criteria triggerCriteria <criteria>
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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:


% set profiles digitParameterHandling
numberTranslationCriteria ENUM1 none Sonus_NULL
Sonus_NULL <9845114525> 1 lookupType enumSipAor
% set global servers enum ENUM_S criteria triggerCriteria
ENUM1
% set global servers enum ENUM_S flags active enable
% set global servers enum ENUM_S serviceType sipAor

3. If ENUM entry is not present, to release the call:


% set global servers enum ENUM_S defaultTreatment
applyFinalTreatment

4. When ENUM entry is not present in the server, the SBC 5x00 does standard
route.
% set global servers enum ENUM_S defaultTreatment
routeasdialed

5. To match the criteria:


% set global country 1 listOfNumberOfDigitsToMatch
criteria 10,6,3,0

6. To see the ENUM configuration:


% show global servers
% show profiles digitParameterHandling
numberTranslationCriteria
ENUM1

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
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>
displaylevel <displaylevel>
% 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

To display different levels of output information in show commands.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

To display different levels of output information in show commands.

Description

Configuring H.323 Signaling Timers


This object allows you to configure signaling timers for the node.

Command Syntax
% set global signaling h323SigTimers
establish <timer value, in seconds>
t301 <timer value, in seconds>
t302 <timer value, in seconds>
t303 <timer value, in seconds>
t304 <timer value, in seconds>
t310 <T3timer value, in seconds10>
tcpConnect <tcpConnect>
% show global signaling h323SigTimers
displaylevel <displaylevel>
establish <timer value, in seconds>
t301 <timer value, in seconds>
t302 <timer value, in seconds302>
t303 <timer value, in seconds>
t304 <timer value, in seconds>
t310 <timer value, in seconds>
tcpConnect <timer value, in seconds>
% delete global signaling h323SigTimers

5 44

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

The T302 call timer (in seconds). Default value is 15 seconds.

T303

0-127

The T303 call timer (in seconds). Default value is 4 seconds.

T304

0-127

The T304 call timer (in seconds). Default value is 20 seconds.

displaylevel

1-64

Displays different levels of output information in show commands.

T310

0-127

The T310 call timer (in seconds). Default value is 10 seconds.

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>

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

To display different levels of output information in show commands.

Command Example
To display the global configuration of all SIP overload control:
% show global signaling sipPeerOverloadControl
samplingPeriod

2;

discardPeriod

1;

stepDownGain

44;

rejectThreshold 33;

5 46

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
displaylevel <displaylevel>
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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
displaylevel <displaylevel>
% 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

To display different levels of output information in show commands.

Command Example
To display the global configuration of all SIP domain names:
% show global sipDomain
sipDomain sipDomain1 {
sipDomain sipDomain2;
nonLocal disable;
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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>
packetServiceProfile <profile name>
services classOfService <CoS identifier>
% show global subscriber <subscriber identifier> <country>
<owning carrier>
packetServiceProfile <profile name>
services classOfService <CoS identifier>
displaylevel <displaylevel>
% 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Subscriber

Global

TABLE 5 20 Global Subscriber Parameters (Continued)


Parameter

Length/
Range

displaylevel

1-64

Description
To display different levels of output information in show
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;
}
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

5 51

CLI Reference Guide


Global

5 52

Subscriber

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00

61

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Accounting

Operations and Maintenance (OAM)

populateIpTgFarEndSwitchType <disabled|enabled>
populateNonPortedLnpNumbers <false|true>
populateRemoteGsxInfoState <disabled|enabled>
secondStageInheritFirstStage <false|true>
sendEgressCdrInfoOnReceipt <false|true>
startAcctState <disabled|enabled>
% show oam accounting admin
displaylevel <displaylevel>
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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

63

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Accounting

TABLE 6 1

Operations and Maintenance (OAM)

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

To display different levels of output information in show commands.

Command Example
To configure CDR administration:
% set oam accounting admin earlyAttemptState enabled
generationMode destination intermediateAcctInterval 20
intermediateAcctMode telcordia intermediateAcctState
enabled intermediateLongDurGenTime 02:03:04.2
intermediateLongDurThreshold 2 intermediateTrapState
enabled maxRecordSequenceNum uint16
populateIpTgFarEndSwitchType enabled
populateNonPortedLnpNumbers true
populateRemoteGsxInfoState enabled
550-05505 Version 1 Release V03.01.00
2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

65

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Accounting

Operations and Maintenance (OAM)

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


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).

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

67

CLI Reference Guide


Operations and Maintenance (OAM)

TABLE 6 2

Accounting

External CDR Server Parameters (Continued)

Parameter

Length/
Range

displaylevel

1-64

To display different levels of output information in show


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]
> show table oam accounting cdrServer status
TYPE

STATE

PROGRESS

SUCCESSFUL

FAILED

PENDING

TRANSFERS

TRANSFERS

TRANSFERS

------------------------------------------------------------------

68

primary

standby

idle

secondary

active

idle

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Accounting

Operations and Maintenance (OAM)

[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]
>
> show table oam accounting cdrServer status
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
Possible completions:
<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]

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

69

CLI Reference Guide


Operations and Maintenance (OAM)

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>
state <disabled|enabled>
radiusServer
cleanupDelay <delay amount>
priority <#>
serverAddress <IPv4 or IPv6 address>
serverPort <UDP port>
sharedSecret <1-128 characters>
state <disabled|enabled>

6 10

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Accounting

Operations and Maintenance (OAM)

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.
(range: 5-25 / default = 10).
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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 11

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Alarms

Operations and Maintenance (OAM)

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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 13

CLI Reference Guide


Operations and Maintenance (OAM)

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
To display different levels of output information in show commands.

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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Event Log

Operations and Maintenance (OAM)

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
Mandatory parameter descriptions

filterAdmin

N/A

Event Log Class Filter configuration table.

<system name>

N/A

SBC 5x00 system name.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 15

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Event Log

Operations and Maintenance (OAM)

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:


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

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 17

CLI Reference Guide


Operations and Maintenance (OAM)

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:

Mandatory parameters:

6 18

acm
arma
asg
atmrm
brm
cam
cassg
cc
chm
cli
cmtsg
cnh
cpx
dbug
diamc
dnsc
drm

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Event Log

TABLE 6 8

Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 19

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Event Log

Operations and Maintenance (OAM)

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.
audit System audit data. These files contain a record of all
management interactions that modify the state of the system.
These files have .AUD extensions. It includes all the changes
made via the CLI and the Netconf interface.
debug System debugging data. These files have .DBG
extensions.
packet Packet information details. These files have .PKT
extensions. If enabled, stores the packet details to .PKT files.
security Security level events. These files have .SEC
extensions.
system System level events. These files have .SYS
extensions.
trace System trace data. These files have .TRC
extensions.
fileCount

1-1024

Specifies the number of event log files that will be maintained for
this event type. (default = 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.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 21

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Event Log

TABLE 6 9

Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 23

CLI Reference Guide


Operations and Maintenance (OAM)

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Local Authentication

Operations and Maintenance (OAM)

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>
displaylevel <displaylevel>
% 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

To display different levels of output information in show commands.

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 25

CLI Reference Guide


Operations and Maintenance (OAM)

Local Authentication

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Radius Authentication

Operations and Maintenance (OAM)

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

radiusAuthentication

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)

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 27

CLI Reference Guide


Operations and Maintenance (OAM)

Radius Authentication

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


SNMP

Operations and Maintenance (OAM)

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>
ipAddress <IP address>
port <port number>
state <disabled|enabled>
trapType <inform|v1|v2>
% show oam snmp
displaylevel <displaylevel>
trapTarget <trap target name>
% show oam snmp trapTarget <trap target name>
displaylevel <displaylevel>
ipAddress <IP address>
port <port number>
state <disabled|enabled>
trapType <inform|v1|v2>
% delete oam snmp trapTarget

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 29

CLI Reference Guide


Operations and Maintenance (OAM)

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

To display different levels of output information in show commands.

Command Example
To display the configuration of SNMP parameters:
% show oam snmp
trapTarget trapTarget4 {
ipAddress 10.34.7.78;
port

161;

trapType

V1;

state

enabled;

6 30

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Traps

Operations and Maintenance (OAM)

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>
state <disabled|enabled>
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>
displaylevel <displaylevel>
dspAdmin

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

6 31

CLI Reference Guide


Operations and Maintenance (OAM)

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

To display different levels of output information in show commands.

Command Example
To display the trap information:
% show oam traps admin
sonusConnexIpSystemCEFanFailureNotification
sonusConnexIpSystemCEFanFailureNotification{
enabled
}

6 32

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00

71

CLI Reference Guide


Profiles

Call Parameter Filter Profile

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>
description <description>
% show profiles
callParameterFilterProfile <profile name>
description <description>
% 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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

CLI Reference Guide


Call Parameter Filter Profile

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 ";
}

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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
internationalOperator
internationalType
ipVpnService
localOperator
longDistanceOperator
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;

550-05505 Version 1 Release V03.01.00


2013 Sonus Networks, Inc. Confidential and Proprietary. All Rights Reserved. Do not distribute without permission.

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