CLI Changes in This Release

New CLI in 10.1.0R0

SBX-65791 Sonus and Genband SBC CAC Gaps

Command Syntax

The updated CLI syntax for the Internal SIP Cause Map Profile is depicted below.

Command Parameters

The new causeMap parameters are described below.

SBX-70699 Multiple audio m-line support

This feature introduces the IP Signaling Profile flags selectCoreStreamForMultiStreamAudioOrImageCall and disableNonCoreAudioAndImageStreams. The flag selectCoreStreamForMultiStreamAudioOrImageCall supersedes the flag multipleAudioStreamsSupport.

Command Syntax

% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags
selectCoreStreamForMultiStreamAudioOrImageCall <disabled | enabled>
disableNonCoreAudioAndImageStreams <disabled | enabled>

Command Parameters

Configuration Example

set profiles signaling ipSignalingProfile DEFAULT_SIP commonIpAttributes flags selectCoreStreamForMultiStreamAudioOrImageCall enabled disableNonCoreAudioAndImageStreams enabled 
commit

For more information, refer to Flags - CLI.

SBX-91700 Emergency call disconnection behavior enhancement

Command Syntax

set addressContext <AC Name> zone  <Zone Name>  sipTrunkGroup  <Sip Trunk Group Name> signaling emgCallByeHandlelegHoldTime <Hold Time>

Command Parameters

Configuration Example

set addressContext AC1 zone ZONE1 sipTrunkGroup TG1 signaling emgCallByeHandlelegHoldTime 10

SBX-92729 Direction attribute behavior

This feature introduces an IP Signaling profile configuration flag "mapDpmToSendrecvForInitialDialog" under Common IP Attributes: Common IP attributes > Flags >  mapDpmToSendrecvForInitialDialog (disabled/enabled).

Command Syntax

% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags 
	mapDpmToSendrecvForInitialDialog <disabled | enabled>

Command Parameters

Configuration Example

set profiles signaling ipSignalingProfile DEFAULT_SIP commonIpAttributes flags mapDpmToSendrecvForInitialDialog enabled

For more information, refer to Flags - CLI.

SBX-101143 Switchover SBC when it receives the signal Ctrl Alt Del x N times

This feature adds the ctrlAltDelete object to the System Admin CLI. When enabled, it manages when to switch over the SBC SWe node when "Ctrl+Alt+Del" is pressed N times within T seconds.

Command Syntax

% set system admin <system_Name> ctrlAltDelete 
	ctrlAltDeleteMode <disabled | enabled>
	ctrAltDelCount <3-6>
	ctrAltDelCountPerSec <1-6>

Command Parameters

Configuration Example

The following example depicts how to enable and configure the ctrlAltDelete object to start a switchover of an active SBC SWe when "Ctrl+Alt+Del"  is entered 4 times within 5 seconds..

set system admin vsbcSystem ctrlAltDelete ctrlAltDeleteMode enabled ctrAltDelCount 4 ctrAltDelCountPerSec 5
commit

SBX-101980 SBC Support SFTP of Compressed CDR Files

You can configure the SBC to transfer CDRs to a remote server as compressed or uncompressed. Currently, if one or more CDR servers are configured, only uncompressed billing files are allowed to be transferred. This feature will allow transferring compressed CDR files through SFTP

Command Syntax

% set oam eventLog typeAdmin acct cdrFileTransferType < compressed | uncompressed >

Command Parameters

Configuration Examples

SBX-55153 Compute R-Factor and populate in CDR even when QOS routing is disabled

This feature adds the parameter "rFactorComputation" in the Global system level configuration CLI. If enabled, the SBC computes a call's R-Factor and adds it to the STOP CDR even if the QoS routing is not enabled.

The R-factor is populated in the STOP CDR in the following fields:

• Ingress Inbound R-Factor
• Ingress Outbound R-Factor
• Egress Inbound R-Factor
• Egress Outbound R-Factor

Command Syntax

% set global system
rFactorComputation <disabled | enabled> 

Command Parameters

Configuration Example

set global system rFactorComputation enabled

For more information, refer to System (Global) - CLI.

SBX-92560 Suppress CDR fields in all record types

This feature adds support in the SBC to suppress the CDR fields added in the specific CAM versions while upgrading to a new release. This control is provided by a configurable CDR Admin parameter. The SBC provides a configuration option for the user to specify the SBC version on which the CDRs must remain formatted, even after the SBC software is upgraded.

Command Syntax

% set oam accounting admin
 cdrVerToGenerate <0 | 10.1>

Command Parameters

Configuration Example

set oam accounting admin cdrVerToGenerate 10.1

SBX-67558 The SBC Certificate Request Generates 4096 Bit Key

This feature enables the SBC to generate a 4096-bit key when a CSR is created. The 4096-bit keys are required when more systems use higher levels of cryptography.

Command Syntax

request system security pki certificate <certificate name> generateCSR keySize keySize4K

Command Parameters

Configuration Examples

request system security pki certificate new4k generateCSR keySize keySize4K csrSub "/CN=TESTCERT/"

SBX-101954/SBX-106802 - SIPREC: Capture the Specific Header/Call Conference Enhancement

The SBC formerly captured Header information which is defined on "sipRecMetaDataProfile" and adds it onto SIPREC Metadata XML. The SIP Initial INVITE is the only message that is supported for building SIPREC Meta Data XML in the earlier versions.

This feature implementation ensures, during the occurrence of the SIP REFER message, the SBC triggers SIPREC Re-INVITE on all the recorded legs based on recording criteria. The recorded call leg that received the SIP REFER message contains the headers values of REFER in the SIPREC Metadata XML update.

Command Syntax

In order to maintain the backward compatibility use the below command with metadataSource set to "fromInvite":

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromInvite/fromLatest> version<0/1> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To enable this feature set metadataSource to "fromLatest":

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest> version<1> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To trigger the SIPREC metadata XML update in case of early media:

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest> version<1> metaDataUpdateForEarlyMedia<Enabled/Disabled> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To trigger the SIPREC metadata XML update in case of refer:

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest>  version<1> triggerMetadataUpdateForRefer<Enabled/Disabled> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

Command Parameters

Configuration Examples

In order to maintain the backward compatibility use the below command with metadataSource set to "fromInvite":

In order to maintain the backward compatibility use the below command with metadataSource set to "fromInvite":

set profiles service sipRecMetadataProfile profile1 state enabled metadataSource fromInvite version 1 sipHeader from sipToXmlTagName xfrom

To enable this feature set metadataSource to "fromLatest":

set profiles service sipRecMetadataProfile profile2 state enabled metadataSource fromLatest version 1 sipHeader to sipToXmlTagName xto

To trigger the SIPREC metadata XML update in case of early media:

set profiles service sipRecMetadataProfile profile3 state enabled metadataSource fromLatest version 1 metaDataUpdateForEarlyMedia Enabled sipHeader contact sipToXmlTagName xcontact

To trigger the SIPREC metadata XML update in case of refer:

set profiles service sipRecMetadataProfile profile4 state enabled metadataSource fromLatest version 1 triggerMetadataUpdateForRefer Enabled sipHeader refer-to sipToXmlTagName xrefer-to

SBX-76219 - REFER Conditional Relay Enhancement

This feature implementation ensures the SBC does not relay the REFER message on the other TG if the new flag in the IPSP is enabled, even when the REFER_RELAY flag is enabled in the IPSP. In the earlier versions, the SBC relayed the In-Dialog REFER message when the REFER_RELAY flag is enabled in the IPSP during the Call Transfer scenario.

Added the suppressReferRelayFromOtherLeg flag.

Command Syntax 

set profiles signaling ipSignalingProfile <profName> commonIpAttributes flags  suppressReferRelayFromOtherLeg enabled/disabled (default: disabled)

Command Parameter

Configuration Example 

set profiles signaling ipSignalingProfile ipsp1 commonIpAttributes flags  suppressReferRelayFromOtherLeg enabled

SBX-106068 - Add Per Node CAC Setting to the SBC

This feature implementation limits the number of total sessions used on the SBC through a CAC setting. In the earlier versions, limiting the number of sessions was achieved by licensing.

Added a configuration to control node level CAC to limit the number of call sessions supported on the node.

Command Syntax

set global cac nodeCac callLimit <Call limit value>

Command Parameters

Configuration Examples

show global cac

Possible completions:
displaylevel - Depth to show
mtrgClient - Object representing Master Trunk Group client instance
mtrgServer - Object representing Master Trunk Group server instance
nodeCac - Allows per node CAC configurations.
sharedCacLimitsPool - Object containing CAC-limits that apply to a set of trunk groups.

show global cac nodeCac

Possible completions:
callLimit - Specifies per node concurrent sessions limit when NWDL license is present.
displaylevel - Depth to show

show global cac nodeCac callLimit

callLimit 10000;

Set command

callLimit 10000;

SBX-106907 ERE Enhancement to Include all Existing PSX LI Support

This feature implementation enables the SBC to process all 10 targets for PC2.0 and process only the targets for which there is a match for dfGroupName in the CDC configuration. The earlier version of the ERE contains gaps with the existing support of LI in the ERE such as encryption of data, Tap ID support for IMS LI, Wildcard target interception, and support for PC2.0 LI. The earlier version of the SBC does not support multiple warrants with overlapping targets but different Tap IDs.

Added a command to create the Master key to use in the encryption of Lawful interception information.

Command Syntax

% set profiles keyManagementProfile <profile name>
     encryptionKey <hex key>
     type type1

% request system admin <SYSTEM NAME> saveLIGenericKey hexEncryptionKey <hex key>

Command Parameters

Configuration Examples

% set profiles keyManagementProfile DEFAULT 
     encryptionKey A1234567890123$% 
     type type1
     commit

request system admin PLUM saveLIGenericKey hexEncryptionKey A1234567890123$%

SBX-94493 JJ-90.30 Interworking Enhancements

The SIP JJ90.30 Interworking Profile defines the interworking behavior between JJ90.30 and various SIP flavors. The SBC Core is enhanced with the addition of a new SIP Flavor to the interworking profile, which enables the desired interworking between JJ90.30 and the proprietary X-Headers. 

This feature includes the following updates:

• The value "X-Header" is added to the SIP Flavor parameter of the SIP JJ90.30 Interworking Profile.
• The parameter "X Aut" is added to the Ioi To Carrier Code Mapping Profile, which can contain a string of up to 16 characters to include in the X-AUT header.

The xAut parameter is added to the ioiToCarrierCodeMappingProfile signaling profile to allow the inclusion of a string of up to 16 characters in the h X-AUT header.

Command Syntax

% set profiles signaling ioiToCarrierCodeMappingProfile <Profile Name> xAut <value: 0 to 9, and a to f >

Command Parameters

Configuration Examples

set profiles signaling ioiToCarrierCodeProfile test_ioi carrierCode 9999 xAut fd02fb05fdfc
commit

Updated the existing profiles signaling sipJJ9030InterworkingProfile sipFlavor parameter with the addition of a new enumeration value "X-Header".

Command Syntax

% set profiles signaling sipJJ9030InterworkingProfile <Profile Name> sipFlavor X-Header

Command Parameters

Configuration Examples

set profiles signaling sipJJ9030InterworkingProfile test_sip_JJ9030 sipFlavor X-Header origIoi test_origIoi termIoi test_termIoi originatingCarrierCode 9999 chargeAreaInformation 56789 
commit

SBX-97198 BFD support on active packet port instead of ICMP

BFD (Bidirectional Forwarding Detection) provides a fast link failure detection mechanism for upper-layer applications. The BFD feature detects failures on any bidirectional forwarding path, such as direct physical link, and between network devices. The BFD feature is used by remote end points or routers to continuously monitor availability of the SBC interfaces. BFD functionality is defined in RFCs 5880, 5881.

Command Syntax

The BFD profile is added to the CLI. Use the following command to create a BFD Profile.

% set profiles bfdProfile <BFD Profile Name>
defaultDetectionTimeout <value, in seconds>
detectionMultiplier <value>
dscpValue <DSCP value>
isMultiHop <false | true>
minTxInterval <value, as milliseconds>
minRxInterval <value, as milliseconds>
remoteIP <remoteIP address>
state <disabled | enabled>

Command Parameters

The Link Detection Group "Link Monitor" object to include a 'BFD Profile' option to specify the BFD Profile to use by the Link Monitors under this Link Detection Group in order to monitor links on the active ports.

Command Syntax

% set addressContext <addressContext Name> linkDetectionGroup <LDG Name> linkMonitor <link monitor name> bfdProfile <BFD Profile Name>

Command Parameter

Refer to pages BFD Profile - CLI and Link Detection Group - CLI.

SBX-105144 Anonymize DTMF data from SBC SWe logs, CDRs, TRC, etc.

The SBC SWe is enhanced with a configurable global system flag to anonymize DTMF information, which can be present in TRC, log and accounting files, by removing the DTMF digits for customers who deploy PCI (Payment Card Industry) solutions. This is to ensure the DTMF digits don't contain personal information such as credit card and personal identification details. File anonymization applies to all TRC log levels down to, and including, log level 4. This feature does not support anonymizing DTMF data below log level 4.

When the flag is enabled, a copy of each existing TRC file is generated in the evlog directory using the file extenstion ".TRC.ANN". The copied files are then anonymized, while the original files remain intact. In HA mode, the active and standby SBCs maintain their own references for the last processed TRC file in the evlog directory (TRC files are not synced in HA mode). As such, data loss may occur for this last TRC file.

If you disable this feature, the copied ".TRC.ANN" files are not deleted in case different log streamers/collectors require them.

A configurable global system flag is added to anonymize logs by removing DTMF digits from TRC files for customers who deploy PCI (Payment Card Industry) solutions.

Command Syntax

% set global system anonymizeDtmfLogging <disabled | enabled>

Command Parameters

Configuration Examples

set global system anonymizeDtmfLogging enabled
commit

SBX-110015/SBX-69938 Notruf Emergency call support

In Germany, a government regulation mandates location support for fixed line emergency calls, such as 110 (Police) and 112 (Fire/Ambulance). When an emergency call is made, the calling number is looked up in a database to find the address information of the subscriber, which needs to be written into the User-to-User Info (UUI) parameter of ISUP messaging as the call is sent over the PSTN to the PSAP.

Notruf is an single emergency line for German networks that uses geolocation to collect and store a caller's information. The information collected includes party location and call center location/numbers. The Notruf for the SBC Core use Ribbon SBC call processing to collect information from the caller. 

Within this context, the primary objectives of this feature is to insert calling party location information, and to provide a dialed emergency number translation (if needed) for emergency calls within German networks.

Command Syntax - configure psapProfile

% set profiles psapProfile <agsN> <gf> <Dialed Digits> psapNumber <Emergency Center>

Command Syntax - configure locationData

% set global subscriber <SubscriberId> <Country> <Owning Carrier> locationData agsN <agsN> gf <gf> HouseNumber <HouseNo> postalCode <PostalCode> streetName <StreetName>

Command Parameters (all are mandatory) 

Configuration Examples

Creation of Notruf Profile:
 
set profiles services sipNotrufProfile <profile_name>
set profiles services sipNotrufProfile <profile_name> state <enabled/Disabled>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails providerid <providerid>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails data-provider <data-provider>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails provider-id-series <provider-id-series>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails provider-contact-uri <provider-contact-uri>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails provider-reference <provider-reference>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails type-of-provider-data <type-of-provider-data>
set profiles services sipNotrufProfile <profile_name> notrufProviderDetails customer-domain <customer-domain>
 
show profiles services sipNotrufProfile <profile_name>
 
Setting of userToUserHdrSupport in trunkgroup
set addressContext default zone <zone_id> sipTrunkGroup <sipTrunkGroup> signaling userToUserHdrSupport
Possible completions:
disabled recv send sendrecv
 
show addressContext default zone <zone_id> sipTrunkGroup <sipTrunkGroup> signaling userToUserHdrSupport
 
 
Attaching the profile to trunkgroup
set addressContext default zone <zone_id> sipTrunkGroup <sipTrunkGroup> services sipNotrufProfile <profile_name>
 
show addressContext default zone <zone_id> sipTrunkGroup <sipTrunkGroup> services sipNotrufProfile

SBX-106069 Capability to shut off call when there is no License Manager refresh in 90 days

The SBC SWe is enhanced with the capability to shut off the calls when there is no License Manager refresh in the last 90 days. The NWDL architecture requires the user to have the node/instance register with the license manager to report the usage, and then refresh the registration periodically. This functionality is enabled by the LACK of a CAPACITY license. If the SBC instance is not successfully registered with the license manager in 90 days, the SBC stops processing calls after sending warning alarms to the user.

Command Syntax

% set system licenseManager licenseServer <name of the license server>
	priority <server selection priority for this server>
 	serverAddress <IPv4 or IPv6 ipaddress of the server>
	userName <username used to access the license manager>
	password <password used to access the license manager>
	connectionTimeout <time to wait for a response from the license manager>

Command Parameters

Configuration Examples

 set system licenseManager licenseServer LM1
	priority 1
	serverAddress 172.29.39.110
	userName restuser
	password sonus123
	connectionTimeout 5000
	commit

To test the License Manager settings, or to trigger a new License Manager registration after a previous registration request fails:

request system licenseManager register

SBX-108941 FCC Mandate Phase 2 - SIP Status 607/608 response code support

The SBC SWe is enhanced with the capability to shut off the calls when there is no License Manager refresh in the last 90 days. The NWDL architecture requires the user to have the node/instance register with the license manager to report the usage, and then refresh the registration periodically. This functionality is enabled by the LACK of a CAPACITY license. If the SBC instance is not successfully registered with the license manager in 90 days, the SBC stops processing calls after sending warning alarms to the user.

Command Syntax

% set profiles signaling ipSignalingProfile <PROFILE_NAME> commonIpAttributes flags supportCallInfoWithSipCause608Rfc8688 <disable | enable>

Command Parameters

Configuration Examples

set profiles signaling ipSignalingProfile DEFAULT_SIP commonIpAttributes flags supportCallInfoWithSipCause608Rfc8688 enable
commit

SBX-106615 SIP Interface support for Identity Hub Service query - DSD

The SBC is enhanced to handle multiple identity headers in embedded contact header parameters for STIR/SHAKEN Service and also support over GW-GW.

Command Syntax

Syntax for skipDTGLookupFor3xxContact

Syntax for support3xxEmbeddedHdrOverGWGW

Command Parameters

For skipDTGLookupFor3xxContact

For support3xxEmbeddedHdrOverGWGW