CLI Changes in This Release

New CLI in 9.0.0R0

SBX-71397 Increase max length of headers in transparency profile

The Transparency profile contains the configurable parameters sipHeader and sipMessageBody in it.

The length of the sipHeader is currently 1-31 and the length of the sipMessageBody is 1-127.

When proprietary headers are used in the above profile, the maximum allowed header length is increased to 63 characters. The existing functionality of Transparency profile remains same with the extended header length.

This feature is supported for GW-GW.

Command Parameters

Command Syntax

Command Syntax Example

SBX-73090 Performance Registration Statistics per Domain

The SBC now collects interval-based SIP registration statistics per domain. This allows you to retrieve statistics for the current interval or a series of intervals using the SBC CLI.

CLI Syntax

The following is the syntax for retrieving per-domain SIP registration statistics for the current statistics interval.

> show status|table addressContext <addressContext_Name> sipRegCountDomainCurStats <DomainName>

The following is the syntax for retrieving per-domain SIP registration interval statistics.

> show status|table addressContext <addressContext_Name> sipRegCountDomainIntStats <DomainName>

Command Parameters

The following statistic fields appear in the output. 

SBX-75799 & SBX-94194 - OPUS support

The show status system gpuTranscodeStatus  CLI command will now show entries for opusTotal and opusUtilization.

Command Syntax

No changes in command status, only in msg returned (see example)

Example

SBX-86128 Specifying More than 50 Destinations for SIPREC Group

To support specifying FQDNs for SRS servers, this feature adds FQDN-related parameters in the following contexts. 

Command Syntax – SRS Group Data

To enable configuring SRS servers with FQDNs, the SBC adds fqdn and fqdnPort parameters to the srsGroupData components in an SRS group profile. 

% set global servers srsGroupProfile <profile name>
    description <0-199 characters>
    loadDistribution <roundRobin | sequence>
    numSimultaneousStream <1-2>
    srsGroupData <0-7>
        cryptoSuiteProfile <cryptoSuiteProfile>
        fqdn <FQDN>
          fqdnPort <0-65535> 
        ipAddress <IP address>
          ipPort <0-65535>
        ipTGId <IP TG Id>
        srtp <disable | enable>
        transport <tcp | tls | udp>

Command Parameters – SRS Group Data

Command Syntax – Start Record

To enable initiating a recording through CLI using an FQDN, the SBC adds the srsFqdn1 and srsFqdn2 parameters for specifying a target SRS server in a SIPREC start record (startRecord).

% request global siprec startRecord
        callLeg
            egress
            ingress
        gcid <0-2147483647>
        numOfStreams <1-2>
        srsFqdn1 <FQDN>
        srsFqdn2 <secondary FQDN>
        srsIpAddress <SRS IP address>
        srsIpAddress2 <secondary SRS IP address>
        srsPort <IP port number>
        srsPort2 <secondary IP port number>
        transport <tcp | udp>
        transport2  <tcp | udp>
        trunkGroup <trunk group name>
        trunkGroup2 <secondary trunk group name>

Command Parameters – Start Record

Command Syntax – Stop Record

The SBC adds the recorderFqdn and recorderId parameters in SIPREC stop records (stopRecord) to enable specifying the FQDN of an SRS server or a unique identifier for the recording session among the criteria that you can use to identify which recording session to stop.

% request global siprec stopRecord
          gcid <0-2147483647>
          recorderAddress <SRS IP address>
          recorderFqdn <SRS FQDN>
          recorderId <session ID>
          recorderPort <port number>

Command Parameters – Stop Record

SBX-88206 Resolve the EMS IP by Service Name

The SBC relies on IP addressing to interact with its operations-related services, such as reaching SNMP trap targets and acquiring services offered by an Element Management System (EMS). However, the addresses of trap targets and the EMS server can occasionally change.  

The Service Discovery for Trap Target Destinations and EMS Registration feature eliminates the need for SBC reconfiguration and re-initiation when IP address numbers change. This feature leverages a Domain Name System (DNS) Service Discovery framework and Fully Qualified Domain Name (FQDN) system to dynamically and automatically accomplish:

• trap destination discovery

• EMS server registration

For more information, refer to the following:

• Service Discovery for Trap Target Destinations and EMS Registration
• Configuring Service Discovery for Trap Target Destinations and EMS Registration
  
• SNMP - CLI
• EMS - CLI
• Service Discovery - CLI

Command Syntax: a new parameter fqdn, for trap target destination Service Discovery

% set oam snmp
    communityString
        <snmpCommunity_Index>
        snmpCommunityName <community name>
    localEngineId <Id>
    securityLevel <authNoPriv | authPriv | noAuthNoPriv>
    trapTarget <trap target name>
        fqdn <SNMP trap target FQDN>
        ipAddress <IP address>
        port <port number>
        state <disabled | enabled>
        targetSecurityLevel <authNoPriv | authPriv | noAuthNoPriv>
        targetUserName <name>
        trapType <inform | v1 | v2 | v3>
    users <username>
        authKey <colon separated hex string>
        authProtocol <HMACMD5 | HMACSHA>
        group <admin | user | operator>
        privKey <colon separated hex string>
        privProtocol <DES | AES128>
    version <v1v2c | v3only>

Command Parameter

Command Syntax: a new command, for EMS registration Service Discovery

% set system ems
    emsFqdn <FQDN for EMS registration>
    emsIpAddressOverride <IP address to override the FQDN>

Command Parameters

Command Syntax: a new command, for Service Discovery

% set system serviceDiscovery
    serviceRegistry <name_of_serviceRegistry>
      nameserver <index_of_nameserver>
        hostname <fqdn> | ipAddress <ip> port <1...65535>
        priority <0...100>
        weight <0...100>
      transport <fallback | tcp | udp | udpEdns0>
      attempts <1...x>
      timeout <100...x>
      resolve
        recurse <false | true>
        roundRobin <false | true>
        ttl <1...x>

Command Parameters

SBX-88296 ANI-DNIS Loop Detection

An ANI-DNIS loop refers to a situation when more than one call request shares the same combination of ANI (Automatic Number Identification) and DNIS (Dialed Number Identification Service) values. This feature adds a new aniDnisZoneloopDetection object to zones. This object has a state parameter to control whether ANI-DNIS loop detection is enabled and a parameter that defines the limit for loop instances per ANI-DNIS pair.

Command Syntax

% set addressContext <addressContext name> zone <zone name> aniDnisZoneloopDetection
    aniDnisZoneLoopInstances <1..1250>
    aniDnisZoneState <disabled | enabled>

Command Parameters

Refer to Zone - ANI-DNIS Loop Detection - CLI for more information.

SBX-89017 - Call Notifications Events to AS

The SBC adds four new entities to configure call notification server data and matching criteria.

• cnsGroupProfile
• cnsGroupCluster
• CallNotificationCriteria
• CallNotificationCriteriaGroup

SIP trunk groups provide two new options for implementing call notifications: 

• CallNotificationCriteriaGroup
• sipCallNotificationMetadataProfile 

Command Syntax - cnsGroupProfile

% set global servers cnsGroupProfile <profile name>
     cnsGroupData <sequence: 0 - 7>
        callNotifyTGId
        remoteAddress 
        remotePort
        transport
     description
     loadDistribution <roundRobin | sequence>
     uri

Command Parameters

Command Syntax - cnsGroupCluster

% set global servers cnsGroupCluster <cluster ID>
     cnsGroupClusterData <sequence: 0>
        cnsGroupId <CNS group profile name>
     description

Command Parameters

Command Syntax - callNotificationCriteria

% set global servers callNotificationCriteria <criteria ID>
     calledPartyId 
     calledPartyType <AoR | number>
     callingPartyId
     callingPartyType <AoR | number>
     cnsGroupClusterId <cns group cluster ID>        
     otherLegTG 
     role <egress | ingress | none>
     userPartType  <none | useCalledNumber | useCallingNumber | useConfigured>
       userPartValue

Command Parameters

calledPartyId

calledPartyType

callingPartyId

callingPartyType

cnsGroupClusterId

otherLegTG

role

userPartType

Command Syntax - callNotificationCriteriaGroup

% set global servers callNotificationCriteriaGroup <group ID>
     callNotificationCriteriaGroupData <sequence: 0 - 31>
        callNotificationCriteriaId <call notification criteria ID>
     description

Command Parameters

callNotificationCriteriaGroupData

callNotificationCriteriaId

description

Command Syntax - SIP Trunk Group Parameters

 Two parameters are added to SIP trunk groups to attach call notification criteria to the trunk group and to specify a SIPREC metadata profile to use in determining the session ID sent in call notifications. This feature uses the existing SIPREC metadata profile to map the session ID, it does not introduce a new type of profile. 

% set addressContext <address context> zone <zone> sipTrunkGroup <TG name> policy callNotificationCriteriaGroup <group ID>

% set addressContext <address context> zone <zone> sipTrunkGroup <TG name> services sipCallNotificationMetadataProfile <sipRecMetadataProfile profile name>

Command Parameters

Refer to Configuring the SBC to Send Unsolicited Call Notifications to Application Servers.

SBX-91618 Using an OOD REFER to Terminate an Active Call

This feature adds a new signaling parameter for SIP trunk groups that controls whether the SBC locally handles OOD REFER requests. 

Command Syntax

% set addressContext <addressContext name> zone <zone name> sipTrunkGroup <trunkGroup name> signaling localOODReferSupport <disabled | enabled>

Command Parameters

Refer to SIP TG - Signaling - Local OOD REFER Support - CLI for more information.

SBX-93310 Enhance the processing of Contact headers in REGISTER messages

This feature adds a new configuration object, the Register Contact Profile, and a new zone option to assign a profile to a zone.

Command Syntax - Profile

% set profiles signaling registerContactProfile <profile name>
    contactIncludeVariables <hostpart | userpart>

Command Parameters - Profile

Command Syntax - Zone

% set addressContext <addressContext name> zone <zone name> registerContactProfileName <registerContactProfile name>

Command Parameter - Zone

For more information refer to Creating Multiple User Registrations Based on Contact Headers in REGISTER Messages.

SBX-87520 - Add VLAN-ID to Available Fields for X-Header Submission on the Monitoring Interface

The parameter vlanTag is added to monitoringProfile header.

Command Syntax

With this enhancement, monitoringProfile has the following parameters:

% set profiles services monitoringProfile <name>
    monitoringIpAddress <IPv4 | IPv6>
    monitoringIpPort <0-65535>
    headerPresence <disabled | enabled>
    header <index>
    headerName <name>
    sourceIpPort <disabled | enabled>
    destinationIpPort <disabled | enabled>
    additionalInformation <disabled | enabled>
    date <disabled | enabled>
    timestamp <disabled | enabled>
    vlanTag <disabled | enabled>

Corresponding changes in the result of the show command are shown below:

% show profiles services monitoringProfile test_monitoring_profile
monitoringIpAddress 10.54.21.25;
monitoringIpPort    80;
headerPresence      enabled;
header 1 {
    headerName            To;
    sourceIpPort          enabled;
    destinationIpPort     enabled;
    timestamp             enabled;
    date                  enabled;
    additionalInformation enabled;
    vlanTag               enabled;
}
[ok][<YYYY-MM-DD HH:MM:SS>]

Command Parameters

SBX-88982 Componentize EMA into REST, Core and Troubleshooting Modules

To disable/enable EMA components from the CLI, the following enhancements are available:

• The parameter ema is added under system admin. The child parameters of ema, each with the disable/enable options, are as follows:
  • enableCoreEMA
  • enableREST
  • enableTS
• To display the status of the EMA components, the parameter ema, with its child parameters, are available under system admin of the show commands.

Command Syntax

To disable/enable the EMA components, use the following syntax:

% set system admin <system_name>
  ema
    enableCoreEMA <disabled | enabled>
    enableREST <disabled | enabled>
    enableTS <disabled | enabled>

To display the status of the EMA components, use the following syntax:

• Within the "configure" mode:

  % show system admin <system_name> ema <enableCoreEMA | enableREST | enableTS>

• Outside of the "configure" mode:

  > show table system admin <system_name> ema <enableCoreEMA | enableREST | enableTS>

Command Parameters

enableCoreEMA

enableREST

enableTS

Command Examples

To configure the EMA components, use the following example:

% set system admin REDGRAPE-SA ema enableCoreEMA enabled enableREST disabled enableTS enabled

To display the status of the EMA components, use the following example:

• Within "configure" mode:

  % show system admin REDGRAPE-SA ema
  enableREST    enabled;
  enableCoreEMA enabled;
  enableTS      enabled;
  [ok][<YYYY-MM-DD HH:MM:SS>]

• Outside "configure" mode:

  > show table system admin REDGRAPE-SA ema
  enableREST    enabled;
  enableCoreEMA enabled;
  enableTS      enabled;
  [ok][<YYYY-MM-DD HH:MM:SS>]

For more information, refer to EMA - CLI.

SBX-91163 Cause Code Mapping for Microsoft TEAMS Interop

The default profiles defaultTsgspec17SipCpc and defaultTsgspec17CpcSip are added to SIP Cause Code Mapping profiles sipToCpcCauseMapProfile and cpcToSipCauseMapProfile respectively.

The default profiles enables quick configuration of SIP cause-code maps based on TSG/SPEC/017, and Microsoft Team's Q.850 acceptance criteria for calls.

Command Syntax

Default TSG SPEC 17 SIP CPC

% set profiles signaling sipCauseCodeMapping sipToCpcCauseMapProfile defaultTsgspec17SipCpc

Similar to other default profiles under sipToCpcCauseMapProfile, the existing parameters automatically associates with defaultTsgspec17SipCpc, as shown below.

Default TSG SPEC 17 CPC SIP

% set profiles signaling sipCauseCodeMapping cpcToSipCauseMapProfile defaultTsgspec17CpcSip

Similar to other default profiles under cpcToSipCauseMapProfile, the existing parameters automatically associates with defaultTsgspec17CpcSip, as shown below:

Command Parameters

Command Examples

To configure defaultTsgspec17SipCpc, see the example below:

% set profiles signaling sipCauseCodeMapping sipToCpcCauseMapProfile defaultTsgspec17SipCpc cancelCause 31 locBye user locCancel user loc3xx networkBeyondPoint loc4xx networkBeyondPoint loc5xx networkBeyondPoint loc6xx networkBeyondPoint

% commit

To configure defaultTsgspec17CpcSip, see the example below:

% set profiles signaling sipCauseCodeMapping cpcToSipCauseMapProfile defaultTsgspec17CpcSip unrecAction q1912Procedure includeQ850Reason enabled

% commit

For more information, refer to the following pages:

• SIP CPC Cause Code Mapping Profiles - CLI
• SIP to CPC Cause Mapping Profile - CLI
• CPC to SIP Cause Map Profile - CLI

SBX-92408 CSSR Counters per Trunk group (Required 2xx, 3xx, 4xx, 5xx, 6xx pegs of calls)

This feature introduces the following enhancements in the CLI:

• The parameter sipCssrStats is added under SIP Trunk Group.
• The following statistics are added addressContext zone (displayed as output of appropriate show <table | status> commands):
  • sipTrunkGroupCSSRCurrentStatistics
  • sipTrunkGroupCSSRIntervalStatistics.
• You can write the CSSR Interval Statistics sipTrunkGroupCSSRIntervalStatistics on a file by enabling under system fileStatisticsAdmin.

Command Syntax

For an existing SIP Trunk Group, the syntax to disable/enable collection of CSSR statistics are as follows:

% set addressContext <acName> zone <zoneName> id <zoneId> sipTrunkGroup <tgName> sipCssrStats <disabled | enabled>

Once enabled, the following commands display the CSSR statistics collected by the SBC:

• CSSR Current Statistics:

  % show <status | table> addressContext  <acName> zone <zoneName> sipTrunkGroupCSSRCurrentStatistics <tgName> <CSSR counter>

• CSSR Interval Statistics:

  % show <status | table> addressContext  <acName> zone <zoneName> sipTrunkGroupCSSRIntervalStatistics <tgName> <CSSR counter>

To write the output of the show command for the interval statistics in a .csv file, use the following syntax:

% set system fileStatisticsAdmin sipTrunkGroupCSSRIntervalStatistics state <disabled | enabled>

Command Parameters

Command Examples

To enable collection of SIP CSSR Statistics for an existing SIP Trunk Group, use the following example:

% set addressContext default zone defaultSigZone id 1 sipTrunkGroup test_sip_tg sipCssrStats enabled
% commit

To display the SIP CSSR Current Statistics, use the following example:

> show status addressContext default zone defaultSigZone sipTrunkGroupCSSRCurrentStatistics

sipTrunkGroupCSSRCurrentStatistics test_sip_tg {
inv_sent 0;
inv_rcvd 0;
alert_sent 0;
alert_rcvd 0;
ansCalls_sent 0;
ansCalls_rcvd 0;
cancel_sent 0;
cancel_rcvd 0;
bye_sent 0;
bye_rcvd 0;
inv200_sent 0;
inv200_rcvd 0;
inv380_sent 0;
inv380_rcvd 0;
inv400_sent 0;
inv400_rcvd 0;
inv403_sent 0;
inv403_rcvd 0;
inv404_sent 0;
inv404_rcvd 0;
inv406_sent 0;
inv406_rcvd 0;
inv408_sent 0;
inv408_rcvd 0;
inv410_sent 0;
inv410_rcvd 0;
inv420_sent 0;
inv420_rcvd 0;
inv480_sent 0;
inv480_rcvd 0;
inv481_sent 0;
inv481_rcvd 0;
inv482_sent 0;
inv482_rcvd 0;
inv483_sent 0;
inv483_rcvd 0;
inv484_sent 0;
inv484_rcvd 0;
inv486_sent 0;
inv486_rcvd 0;
inv487_sent 0;
inv487_rcvd 0;
inv488_sent 0;
inv488_rcvd 0;
inv500_sent 0;
inv500_rcvd 0;
inv501_sent 0;
inv501_rcvd 0;
inv502_sent 0;
inv502_rcvd 0;
inv503_sent 0;
inv503_rcvd 0;
inv504_sent 0;
inv504_rcvd 0;
inv580_sent 0;
inv580_rcvd 0;
inv600_sent 0;
inv600_rcvd 0;
nonInv603_sent 0;
nonInv603_rcvd 0;
nonInv606_sent 0;
nonInv606_rcvd 0;
nonInvUnknown_sent 0;
nonInvUnknown_rcvd 0;
}

To write the SIP CSSR Interval Statistics to .csv files, use the following example:

% set system fileStatisticsAdmin sipTrunkGroupCSSRIntervalStatistics state enabled
% commit

For more information, refer to the following pages:

• SIP Trunk Group - SIP CSSR Stats - CLI
• Show Status Address Context - Zone
• Show Table Address Context - Zone