In this section:

New CLI in 9.2.0R1


Info

Default values are enclosed in square brackets [ ].

SBX-59346 Beep Tone Required During Recorded Calls

The SBC SIPREC feature is enhanced with:

  • The ability to play beep tone in recorded calls. This capability is config driven.
  • Operators can configure the tone power, interval between tones, and the direction in which the tone should be played.

In addition to SIPREC feature, you can attach the Beep tone profile to ingress/ egress TGs (without SIPREC) and the beep tone will get played in accordance with the direction mentioned in the beep tone profile.

Command Syntax

The following example shows the syntax for beepToneProfile

set profiles media beepToneProfile <profile_name>
   direction <ingress | egress | both>
   durationBetweenTone <0-65535>
   tonePower <-50-3>


For more information, refer to Beep Tone Profile - CLI.


SBX-86241 Stream RTP/RTCP Stats and DTMF Events to Ribbon Protect

To facilitate monitoring and management of voice quality with the SBC Core and the Ribbon Protect, the SBC Core is enhanced to support the following functionality to allow service providers to see discrete variations in voice quality, as well as monitor SLA and network operations.

  • Communicate with Ribbon Protect
  • Report media quality statistics (RTP/RTCP) and DTMF packets to Ribbon Protect.

Command Syntax

The following example shows the syntax for mediaProbe:

% set system media mediaProbe
    dscpValue <0-63>
    encryptionType <None>
    format <rtcp>
    mediaProbeAddressContext <addressContext>
    mediaProbeIpInterfaceGroup <mediaIpInterfaceGroup>
    protocolType <udp>
    reportingInterval <1-8>
    state <disabled | enabled>

Command Parameter


ParameterDescription
mediaProbe

The object that captures and reports media quality statistics (RTP/RTCP) and DTMF packets. Media Probe accepts the following values:

  • dscpValue <DSCP value> – The DSCP value for Media Probe RTCP application packets. Range: 0-63. Default = 0.
  • encryptionType – The encryption type used towards the Ribbon Protect server. Currently, the SBC does not support any encryption.
    • none (Default).
  • format – The Media Probe format used to report qCDR (quality CDR capturing QoS statistics associated for a leg for each RTP-based stream). Currently, the SBC only supports RTCP.
    • rtcp
  • mediaProbeAddressContext – Address Context associated with the Media Probe IP Interface Group.
  • mediaProbeIpInterfaceGroup – Media IP Interface Group used to transmit Media Probe packets to the remote Ribbon Protect server.
  • protocolType – The network protocol used to transfer the data to the remote server. Currently, the SBC supports only UDP
    • udp 
  • reportingInterval <1-8> – The interval at which RTCP application packets are sent to the remote Ribbon Protect server, expressed as an integral multiple of the Media RTCP Control senderReportInterval value (configurable to 5-120 seconds). Default is "1". 
    For example, if senderReportInterval is set to 5 seconds, then
    • set reportingInterval to "1" to send media probe packets every 5 seconds (senderReportInterval x 1).
    • set reportingInterval to "8" to send media probe packets every 40 seconds (senderReportInterval x 8).
  • state – Use this flag to enable/disable the system-wide Media Probe state.
    • disabled (default)
    • enabled

For more information, refer to Media System - CLI.


SBX-97041 LDAP for Centralized Authentication

The SBC Core is enhanced in this release to also support Lightweight Directory Access Protocol (LDAP) for external centralized authentication. LDAP is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an Internet Protocol network. It is a simplification of the X. 500 Directory Access Protocol (DAP) used to access directory information. Using this simple authentication method, the LDAP client sends the username and password to the LDAP server.

To support this behavior, the SBC is enhanced with the following CLI/EMA changes:

  • Added External Authentication Type option to System Admin to choose LDAP or RADIUS for external centralized authentication.
  • Added LDAP Authentication to OAM to configure an LDAP server, as well as LDAP filters, retry criteria and a command to re-enable the LDAP server.
  • Added LDAP Status command.

Limitations:

  • LDAP authentication is not supported for access to the Platform manager.
  • There is no support for specifying the LDAP server address using a FQDN.

Command Syntax

The following example shows the syntax for externalAuthenticationType:

%  set system admin <SYSTEM> externalAuthenticationType <ldap|radius>

Command Parameters

ParameterDescription
externalAuthenticationType

Use this parameter to specify the LDAP external authentication type.

  • ldap
  • radius (default)

NOTE: You must set this field to "ldap" to use external authentication for LDAP.


LDAP Authentication

LDAP Server

Use this parameter to configure information to communicate with one or more LDAP servers.

Command Syntax

% set oam ldapAuthentication ldapServer <serverName>
    binddn <name>
    bindMethod <sasl|simple>
    groupNameAttribute <groupName, or empty string>
    ldapServerAddress <IPv4/IPv6 address>
    ldapServerPort <valid port>
    priority <1-3>
    saslMechanism <plain>
    searchbase <base>
    state <disabled|enabled>
    transport <ldaps|tcp|tls>


Command Parameters

LDAP Authentication Parameters

Parameter

Length/Range

Description

Mandatory (M)
or Optional (O)

serverNameUp to 23 characters<serverName> – The name of this LDAP server.M
binddnString

<name> – The distinguished name to use for the bind operation (only used for simple binds).

M, if bindMethod = simple
bindMethodN/A

Specify the bindMethod to use.

  • sasl – Use the Simple Authentication and Security Layer (SASL) option.
  • simple (default) – Use this option to bind the LDAP clients to the LDAP server with a username and password.
O
groupNameAttributeString

Use this parameter to define the group name attribute.

  • <attribute of user record> – The attribute in the user record that contains the CLI group name.
  • <empty string> (default) – leave as an empty string if the groupname is obtained using filters.
O
ldapServerAddressIPv4/IPv6 address<IP address> – The IPv4/IPv6 address of the LDAP serverM
ldapServerPort1-65535

<port number> – The LDAP server port. 

The default value is 389.

NOTE: If transport = ldaps, specify port 636.

O
priority1-3<priority #> – The server priority, where '1' is the highest priority.M
saslMechanismN/A

The SASL mechanism to use.

  • plain (default)
O
searchbaseString

This parameter specifies the location where the user records are located, and serves as the base for the LDAP query.

M
stateN/A

The state of this LDAP server.

  • disabled (default)
  • enabled
O
transportN/A

The transport type to use.

  • ldaps
  • tcp (default)
  • tls
O

LDAP Filters

Use this parameter to configure a set of filters against predefined or custom groups to determine if the specified user is a member of those groups. Each filter is accessed in the order specified in the LDAP Filters table. If a filter returns at least one record, then the user is considered part of that group, and that group name is used.

Command Syntax

% set oam ldapAuthentication ldapFilters
    filter <LDAP filter string>
	groupName <name of CLI group name to login to CLI>
	order <integer>


Command Parameters

LDAP Filter Parameters

Parameter

Length/Range

Description

filterString

<filter string> – The LDAP filter (valid LDAP filter string) used to determine if the specified user is a member of the group defined by groupName.

The special string %%USERNAME%% will get replaced with the current user name being validated.

For example, if the user is jsmith, the filter (&(uid=%%USERNAME%%)(accessLevel:=userAccessLevel1)) becomes (&(uid=jsmith )(accessLevel:=userAccessLevel1))

groupNameN/A

The CLI group name to use for logging onto the CLI. 

  • Administrator
  • Calea
  • FieldService
  • Guest
  • Operator
  • SecurityAuditor
  • (The user-defined group containing the name of a custom group configured on the SBC)
orderInteger

<integer> – Specify a unique number to set the order to process the filter. The filter with an order  of '1' is processed first. 


LDAP Retry Criteria

Use this parameter to configure the LDAP Server Retry criteria settings. 

Command Syntax

% set oam ldapAuthentication retryCriteria
	retryTimer <500-45000>
	retryCount <1-3>
	oosDuration <0-300>


Command Parameters

LDAP Retry Criteria Parameters

Parameter

Length/Range

Description

retryTimer 500-45000

<timer value> – The time, in milliseconds, before the SBC attempts another authentication request.

Default: 1000

retryCount 

1-3

<retryCount #> – The number of retries the SBC performs to attempt authentication.

Default: 3

oosDuration 0-300

<oosDuration #> – The time, in minutes, the LDAP server remains out of service after a timeout.

Default: 60

Command Example

set oam ldapAuthentication retryCriteria retryTime 1000 retryCount 3 oosDuration 60

Re-enable Server

An LDAP server is marked "unavailable" when the SBC cannot reach it. Use this command to re-enable the LDAP server, which will set the status back to "available".

Command Syntax

% request oam ldapAuthentication ldapServer <servername> reEnableServer


Command Parameters

Re-enable Server Parameters

ParameterDescription
ldapServer<serverName> – The name of the LDAP server.
reEnableServer

An LDAP server is marked "unavailable" when the SBC cannot reach it.

Use this action to re-enable an LDAP server, which then sets the status back to "available". 

For more information, refer to:


SBX-101917 Utilization Field For Peer Overload Throttling

SLB uses a weighted round robin algorithm to load balance the SIP traffic to the registered SBCs. Prior to the version 9.2, the following fields were used to calculate weight which is assigned to each SBC registered to SLB: 

  •  503 rejections or the peer loss ratio.
  •  SBC capacity, in the range of 0-100 currently defaults to 100. 

The SLB continues to assume the desired behavior is to evenly distribute load to each SBC, with no regard to differences in the capacity or current usage of each SBC. It also does not provide a way to limit call traffic to a registered SBC based on user configuration.

Hence, a utilization field is introduced and is updated every second to the SLB from the SBC. The utilization is calculated as (number of current sessions/estimated max sessions). Weight calculated on SLB is 100-Utilization.

A configurable on SBC is provided to configure a user-defined utilization value which when enabled overrides the above mechanism.

The following CLI commands are deprecated:

system/slb/globalLossRatio
leaf globalLossRatio {
    tailf:display-when "/system/sbcPersonality/role ='slb'";
    type sonusSlbGlobalLossRatioType;
    default 100;
    tailf:info "
        Global Loss Ratio threshold on SLB to generate a trap (Range is 1 - 100 %)
      ";
 }

The following configuration is introduced on the SLB:

% set system slb
globalUtilization <1 ... 100>

The following configuration is introduced on the SBC to override the weight it reports to the SLB:

% set system slb
overloadControlOptions
-     uilizationOverride <disabled | 0 ... 100>

Command Parameters - slb

Command Parameters

Parameter

Length/Range

Description

globalUtilization<1 .. 100>The Global Utilization threshold on the SLB to generate an alarm. Range is 1-100.

Command Parameters - sbc

Command Parameters

Parameter

Length/Range

Description

overloadControlOptionsN/A
  • utilizationOverride - The Utilization value configured on the SBC to override the weight of the SBC on the SLB.
    • disabled (default)
    • 0-100

For more information, refer to SIP Aware Front End Load Balancer (SLB) - CLI on the SBC.

New CLI in 9.2.2R0/R1

SBX-106309 Duplicate Address Detection Improvements

In the SBC 9.2.2R1 release, the Duplicate Address Detection (DAD) process job is automatically installed as part of the install/upgrade process. The SBC also adds alarms to indicate duplicate address detection, and alarms to indicate link detection toggling.

DAD Alarms

  • sonusIPv6DuplicateManualReviewRebootingNotification
  • sonusIPv6DuplicateManualReviewNoRebootNotification

Link Detection Alarms

Alarms are triggered when link detection toggling starts/clears.

  • sonusSbxLvmPrgLinkFailureToggleNotification
  • sonusSbxLvmPrgLinkFailureToggleClearedNotification
  • sonusSbxLvmPrgSwitchoverToRecoverLinksNotification


This feature fixes the DAD failure issue when duplicate IPs are present on two nodes. Due to duplicate IP addresses, link detection failure occurs and the link monitorStatus indicates socketCreateFailed after switch over. 

Toggle Recover Timer

This feature adds the link detection toggleRecoverTimer. The toggleRecoverTimer starts if configured with a non-zero value when the SBX stops toggling between primary and secondary ports - 5 switches in 30 seconds (2 minutes for BFD). When this timer expires, the SBC checks the link status. If the links are not good and the node switchover is possible (checks multiple conditions such as the standby node's state, peer LDG state, and so on), then it initiates the node switchover and triggers an alarm to highlight the condition. If the switchover is not possible, or the switchover doesn't succeed, then the timer restarts.

Command Syntax
% set system admin <systemName> linkDetection toggleRecoverTimer <0-3600>
Command Parameters
ParameterLength/RangeDefaultDescription

toggleRecoverTimer

0-3600 seconds0

The toggleRecoverTimer starts if configured with a non-zero value when the SBC stops toggling between primary and secondary ports. 

When the timer expires, the alarm sonusSbxLvmPrgSwitchoverToRecoverLinksNotification - MAJOR is generated.

Configuration Example

Issue the following commands to start the Toggle Recover Timer on a system named "SBC-1" when it stops toggling between primary and secondary ports.

% set system admin SBC-1 linkDetection toggleRecoverTimer 120
% commit

For more information, refer to Link Detection - CLI.

SBX-85797- SIP Status 607/608 Response Code Support with ISUP 21 Interworking

This feature enables the cause code mapping profile in the SBC to support new set of response codes 607/608/609/610.

For more information, refer to:

Note

The parameters introduced in SBC 9.2.2 are listed in Command Parameter tables. The profile CLIs are not new.


SIP to CPC Cause Mapping Profile

Command Syntax

SIP to CPC
% set profiles signaling sipCauseCodeMapping 
	sipToCpcCauseMapProfile <sipToCpcCauseMapProfile> 
		loc3xx <locNxx> 
		loc4xx <locNxx> 
		loc5xx <locNxx> 
		loc6xx <locNxx> 
		locBye <locBye> 
		locCancel <locCancel> 
		cancelCause <cancelCause> 
		baseProfile <defaultCpcSip | defaultQ1912CpcSip | defaultRfc3398CpcSip | defaultTs29163CpcSip | defaultTsgspec17SipCpc> 
		causeMap <causeMap> 
			cpcCause <cpcCause>
			location <loc value>

% show profiles signaling sipCauseCodeMapping sipToCpcCauseMapProfile <sipToCpcCauseMapProfile> displaylevel <displaylevel> 

% delete profiles signaling sipCauseCodeMapping <sipToCpcCauseMapProfile> 

Command Parameter

Parameter

Length/RangeDescription

causeMap

300-799


Specifies the SIP status code that can be mapped to the following cpcCause and location value:
ParameterLength/RangeDescription
  • cpcCause
1-255

CPC Cause value for a given SIP cause value.

  • location
N/A

Specifies the cause location.

  • internationalNetwork
  • localPrivateNetwork
  • localLocalNetwork
  • localInterfaceControlledByThisSigLink
  • networkBeyondPoint
  • privateBranchExchange
  • remoteLocalNetwork
  • remotePrivateNetwork
  • transitNetwork
  • user

CPC to SIP Cause Map Profile 

Command Syntax

CPC to SIP
% set profiles signaling sipCauseCodeMapping
	cpcToSipCauseMapProfile <profile name>
		baseProfile <defaultCpcSip | defaultQ1912CpcSip | defaultRfc3398CpcSip | defaultTs29163CpcSip | defaultTsgspec17CpcSip>
		causeMap <CPC cause value>
			location <loc value>
				sipCause <sip cause value>
			q850Reason <Q.850 cause value>
			sipCause <sip cause value>
		includeQ850Reason <disabled | enabled> 
		unrecAction <q1912Procedure | rfc3398Procedure | ts29163Procedure> 

% show profiles signaling sipCauseCodeMapping cpcToSipCauseMapProfile

% delete profiles signaling sipCauseCodeMapping cpcToSipCauseMapProfile <profile name> 

Command Parameter

Parameter

Length/RangeDescription

causeMap

N/A

Specifies the CPC-to-SIP cause mapping values. Enter cause map value between 1-255 and specify the following parameters:

  • location Specifies the cause location.
    • internationalNetwork
    • localPrivateNetwork
    • localLocalNetwork
    • localInterfaceControlledByThisSigLink
    • networkBeyondPoint
    • privateBranchExchange
    • remoteLocalNetwork
    • remotePrivateNetwork
    • transitNetwork
    • user
      • sipCause – SIP Cause value for a given CPC cause and location value. Range: 300-799.

SBX-106857 Use Different Response Codes for CAC Failures

The SBC is enhanced to support a configurable SIP response code for each type of CAC rejection at various levels so that the operator can differentiate between the types of failures. Operators are able to map the different categories of CAC specific internal CPC cause codes to a SIP error response code.

This specific Requirement will address Trunk Group level configurations to allow customer desired SIP response code to use when CAC check fails.

Trunk Group level CAC configuration can also be done using sharedCAC Pool.

If a PSX 'Response Profile' is configured, then the SBC uses a SIP Error Response code as per the PSX returned 'Response Profile'.


Command Syntax

% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <profile_name> causeMap
    congestionPolicing sipCause <300-606>
    otherReqRatePolicing sipCause <300-606>
    regRatePolicing sipCause <300-606>
    regTGLimit sipCause <300-606>
    regTimeout sipCause <300-606>
    subsEndPointRatePolicing sipCause <300-606>
    subsRatePolicing sipCause <300-606>
    subsTGLimit sipCause <300-606>  
    TGCallLimit sipCause <300-606>
    TGIngressCallLimit sipCause <300-606>
    TGEgressCallLimit sipCause <300-606>
    TGIngressCallRate sipCause <300-606>
    TGEgressCallRate sipCause <300-606>


Command Parameters

Parameter

Length/Range

Default

Description

M/O

TGCallLimit 

300 - 606

0

TG Level Call Limit: The SIP cause code used when the trunk group level Call limit is exceeded.

O
TGIngressCallLimit300 - 6060TG Level Ingress Call Limit: The SIP cause code used when the trunk group Ingress level Call limit is exceeded.O
TGEgressCallLimit 300 - 6060TG Level Egress Call Limit: The SIP cause code used when the trunk group Egress level Call limit is exceeded.O
TGIngressCallRate 300 - 6060TG Level Ingress Call Rate: The SIP cause code used when the trunk group Ingress level Call Rate is exceeded.O
TGEgressCallRate  300 - 6060TG Level Egress Call Rate: The SIP cause code used when the trunk group Egress level Call Rate is exceeded.O


Configuration Examples

To set SIP response code 505 for TG level Ingress Call limit failure, execute the following CLI.

% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile INP causeMap TGIngressCallLimit sipCause 505


New CLI in 9.2.3R0

SBX-107845 P-Charging-Vector Header Management Enhancements

The SBC Core's SIP trunk group signaling configuration is enhanced to include a parameter, generateOrReplacePCV, to relay or generate a P-Charging-Vector (PCV) header, depending upon the terminating and originating Inter-Operator Identifier (IOI) values sent in the PCV header.

Use the parameter, generateOrReplacePCV,  to specify the term-IOI and orig-IOI identifiers, as well as enable/disable the option to relay or generate a PCV header using the configured values. By default, this feature is disabled. 

  • If the generateOrReplacePCV flag is enabled, the SBC either replaces the term-IOI and orig-IOI values in a PCV header (if present) with the provisioned values, or generates the missing PCV header term-IOI and orig-IOI from the incoming message with the provisioned values. 
  • If the sendPCVHeader flag is enabled on an SBC trunk, the SBC sends the PCV header in the outgoing message. If the flag is disabled, the SBC does not add the PCV header to the outgoing message. 


Command Parameters

Parameter

Length/Range

Description

generateOrReplacePCVN/AUse this configuration to relay or generate a P-Charging-Vector (PCV) header, depending upon the terminating and originating Inter-IOI values sent in the PCV header.

state

N/A

Enable this flag to allow the SBC to either replace the term-IOI and orig-IOI values in a PCV header (if present) with the provisioned values, or generate the missing PCV header term-IOI and orig-IOI from the incoming message with the provisioned values. 

  • disabled (default) 
  • enabled

origIOI

1-63 characters, or null

Specify the originating inter-operator ID (default = null).

termIOI1-63 characters, or null

Specify the terminating inter-operator ID (default = null).

sendPCVHeaderN/A

Enable this flag to send the PCV header in the outgoing message. If disabled, the SBC does not add the PCV header to the outgoing message. 

  • disabled (default)
  • enabled

For more information, refer to SIP TG - Signaling - Generate Or Replace PCV - CLI.

SBX-107111 Scalable CLI screening solution for From and P-Asserted-ID

To replace the Q-series SBC, the SBC Core supports screening of both the From username and the P-Asserted-ID username presented to the SBC from SIP PBX customers. 

To support the requirements on the ERE, the solution uses dmpm as a service. Triggering a service on ERE or PSX uses the reverse lookup mechanism into the DB cache. When the call is processed at the service layer, PES looks up into the in-memory cache with the data received in the call. The matching procedure always starts with the priority of the call processing element type. If it finds a match, then it will execute the service, in this case the dmpm rule. 

  • The From username or P-Asserted-ID username received in the ingress INVITE is normalized to E.164 format. These two username values are treated independently. The normalization is applied only if the username has a certain prefix and is received on a certain trunkgroup. It is not mandatory to receive the P-Asserted-ID username for all the calls.
  • If the From username or P-Asserted-ID username received in the ingress INVITE does not match the prefixes, then the header is assigned a default value.
  • The ERE application can screen on at least 30000 prefixes per trunkrgroup, and 75,000 prefixes per SBC.
  • A new flag is added to the feature control profile. When this flag is enabled, PES executes the dmpm rule service even if the route is determined prior to PreRouter Layer. If a rule service other than the dmpm rule service is matching the trigger criteria, it will not be executed.
  • There are few cases where the route is determined before the service execution layer for example using DTG, Tgrp and Trunk-context received in the D+ request. For such cases currently service execution is skipped. The ERE executes the DmPm Service even if route for the call is determined before the service execution layer. A control flag is required to execute the DmPm service even if it is routed before pre router layer.


New CLI in 9.2.4R0

SBX-102448 SBC On-hold Race Condition

The SBC is enhanced with the addition of three gateway-specific flags in the SIP trunk group signaling configuration to support the handling of 100rel-based back-to-back 18x responses using SDP changes to block irrelevant Re-INVITE/UPDATE messages between gateways. This configuration will prevent potential one-way audio issues between gateways.

  • minimizeRelayingOfMediaChangesAtGwSg
  • disableMediaLockDownAtGwSg
  • relayDatapathModeChangesAtGwSg


CLI Syntax
% set addressContext <Address Context name> zone <ZONE_IAD/ZONE_AS> sipTrunkGroup <TG_IAD/TG_AS> signaling disableMediaLockDownAtGwSg <disabled | enabled >
% set addressContext <Address Context name> zone <ZONE_IAD/ZONE_AS> sipTrunkGroup <TG_IAD/TG_AS> signaling minimizeRelayingOfMediaChangesAtGwSg <disabled | enabled>
% set addressContext <Address Context name> zone <ZONE_IAD/ZONE_AS> sipTrunkGroup <TG_IAD/TG_AS> signaling relayDatapathModeChangesAtGwSg <disabled | enabled>

For more information, refer to:

SBX-114828 Update SBC Provisioning Limits (add "largeuseracl" SWe Config Profile Option)

The system SWe Config Profile provisioning option "largeuseracl" is added in this release to allow a higher number of IP ACLs for larger networks. The "largeuseracl" profile is applicable to the SBC SWe and SLB with VM Memory ≥ 18 GiB RAM.  Refer to SWe Config Profile Selection - CLISystem - Swe Config Profile Selection (EMA) and SBC Provisioning Limits for details.

CLI Syntax
% set system sweConfigProfileSelection name <extrasmall | large | largeuseracl | small>