New CLI in 8.0.0R0

SBX-68167 Remove SLS from Code and Documentation

Commands and tables supporting the site license server (SLS) have been removed. The related licensing is no longer supported. In a related change, the license mode previously referred to as "legacy" has been renamed with the more descriptive term "node locked."  The term "nodeLocked" now appears in license-related table output. 

The updated command to set license mode appears below:

% set system licenseMode mode <domain | nodeLocked>

The following tables are no longer populated and are not available using show table system or show status system:

• licenseFeatureStatus
• licenseRequiredStatus
• licenseServer
• licenseServerStatus

The command to reset license status tables has been removed.

DELETE SECTION BEFORE PUBLICATION

New CLI in 7.2.0R0

SBX-50672 Stir/Shaken Support

To enable authenticated identity management, stiProfile is added and is associated to a SIP Trunk Group. If the state of the stiProfile attached to the ingress trunkgroup is enabled, the SBC sends STI related information to the PSX, which is provisioned to either sign, verify or tag the call. The SBC then receives information from the PSX about the service provided that is signing, verification or tagging

The provisioning on the PSX  dictates whether STI related headers are signaled on the egress. 

The stiProfile has to be enabled on the egress sip trunkgroup for STI headers to be signaled on the egress.

For transparently passing Date Header, existing Header Transparency feature is used.

A new action "retryWithoutIdentity" is added to the retryProfile. When this action is configured for a SIP response code, on receipt of the response code the same route is tried without Identity Headers.

For the next route to be tried, the user provisions the reasonCode in the crankback profile. If the reasonCode is not provisioned in the crankback profile, the call fails.

Command Syntax

A new stiProfile is added under Services:

set profiles services stiProfile <profileName>
Possible Completions
state - enabled or disabled.

 set profiles services retryProfile <retryprofile_name> triggerActionRule <Rule_Number> sipResponseCode <SipresponseCode> actionType retryWithoutIdentity

Command Parameters

STI Profile Parameters:

Retry Profile Parameters

SBX-51418 Increase in the number of Rules in SMM Profile

Rule parameter upper range limit changed to 256:

SBX-52861 Add a Dynamic SIP Signaling Port

The existing CLI command to configure the system-wide media port range is modified to incorporate an optional configuration that divides the media port range into a high-priority port range and a low-priority port range. Under congestion conditions, all the packets received on ports outside high priority media range will be dropped automatically by NP layer. The new CLI allows you to configure the high priority media port range. 

The High Priority port range is a contiguous range of ports that can lie either at the top or at the bottom of the media port range.

• The high-priority media port range can be configured only at the Top or Bottom of the system level media port ranges.
• Whenever the system level media port range changes, the high-priority media port range changes automatically with respect to the system-level media port range. 
• The size of the high priority media port range cannot exceed 25 percent of the overall configured media port range. 
• Packets received on the ports falling in the high priority port range will not be subjected to discard by NP even in congestion conditions.

Ribbon recommends that signalling ports inside the media port range reside within the high priority port range, if configured.

For the sigport feature, the high-priority media port range will have impact only the ISBC because the pool for udp port is common for media and signalling.

Fot the DSBC, this configuration should appear on MSBC.

If signaling port lies outside the media port range then no CONTROL-XRES will be allocated for the configured port.

Command Syntax

Example

% set system media mediaPortRange baseUdpPort <base> maxUdpPort <max>
    highPriorityPortRangeLocation <top/bottom>
    highPriorityPortRangeSize <value (<25)> 

Command Parameters

SBX-54420 Create Different Triggers Based on TLD (Top Level Domain)

The SBC now allows users to create multiple ENUM services for same service type (sipAor, CNAM, or LNP), and to create different triggers based on TLD (Top level Domain).

For example:

Service1 -> SIPAoR type -> Trigger1 as TG1 -> ENUM TLD example1.net

Service2 -> SIPAOR type -> Trigger2 as TG2 -> ENUM TLD example2.net

Command Syntax

Configuring ENUM services

The mandatory priority parameter must be assigned when creating Enum Service. A lower value represents a higher priority.

> set global servers enumService <EnumService Name> priority <value>

Showing configured ENUM services

To display configured ENUM servers:

% show global servers enumService <service name>

Configuring skipFurtherEnumServices

When enabled, the SBC skips all the next services and goes directly to routing.

set global servers enumService <EnumService Name> flags skipFurtherNumberTranslationServices  <disable/enable>

Command Parameters

SBX-57592 Trap to notify of a DB out of sync condition

An entity, dbSyncCheckProfile, is added. A parameter, syncCheckInterval is added to dbSyncCheckProfile to configure the time interval for verifying the database integrity. It will raise an existing TRAP "sonusDatabaseConfigPolicyDataOutOfSyncNotification" when a DB Out of Sync condition arises. 

Command Syntax

Execute the following command to show the dbSyncCheckProfile and syncCheckInterval parameter:

% show profiles dbSyncCheckProfile <DEFAULT>
syncCheckInterval 5;

% set profiles dbSyncCheckProfile <DEFAULT>
syncCheckInterval
<unsignedInt, 0 | 5 .. 30>

Command Parameters

% show table profiles dbSyncCheckProfile

% set profiles media codecEntry <name> codec evs
    dtmf
        relay <relay_type>
        removeDigits <disable | enable>
    maxBitRate <5.9 | 7.2 | 8 | 9.6 | 13.2 | 16.4 | 24.4 | 32 | 48 | 64 | 96 | 128> 
    minBitRate <5.9 | 7.2 | 8 | 9.6 | 13.2 | 16.4 | 24.4 | 32 | 48 | 64 | 96 | 128>
    packetSize <20 | 40 | 60 | 80 | 100>
    preferredRtpPayloadType <0-127>

maxBitRate

minBitRate

 % set profiles media codecRoutingPriority <ingress codec group: AMRWB | EVS | G722 | G7221 | G7291 | MSRT | OPUS | SILK>
    entry <egress codec group: AMRWB | EVS | G722 | G7221 | G7291 | MSRT | OPUS | SILK> <priority number>

 % set profiles media toneCodecEntry <toneCodecEntry name>
    codec evs
       codingRate <EVS-0-7.2kbps | EVS-1-8.0kbps | EVS-2-9.6kbps | EVS-3-13.2kbps | EVS-4-13.2kbps | EVS-5-16.4kbps | EVS-6-24.4kbps | EVS-7-32kbps | EVS-8-48kbps |
EVS-9-64kbps | EVS-10-96kbps | EVS-11-128kbps>

Command Syntax

Two new parameters are added to codecEntry configuration when the codec type is one of the SILK variants: maxAverageBitRate and useSilkDTX. These are added to the existing syntax below:

% set profiles media codecEntry <name> codec <silk8|silk12|silk16|silk24>
    dtmf
        relay <relay_type>
        removeDigits <disable | enable>
    fax
        failureHandling <continue | disconnect>
        toneTreatment <treatment_type>
    maxAverageBitRate <silk8:6000-20000|silk12:7000-25000|silk16:8000-36000|silk24:12000-40000>  
    modem
        failureHandling <continue | disconnect>
        toneTreatment <treatment_type>
    packetSize <packetSize>
    preferredRtpPayloadType <0-128>
    silenceSuppression <disable | enable>
    useSilkDTX <0 | 1>

maxAverageBitRate 

useSilkDTX

% set profiles media packetServiceProfile <unique_profile_name>  packetToPacketControl
  
    codecsAllowedForTranscoding
        otherLeg <amr | efr | evrc | g711a | g711u | g722 | g726 | g729 | g7221 | g7222 | g7231 | ilbc | opus | silk | t38>
        thisLeg <amr | efr | evrc | g711a | g711u | g722 | g726 | g729 | g7221 | g7222 | g7231 | ilbc | opus | silk | t38>

A configurable is added to configure and modify the licensed OOD rate limit at a global level:

• set global sipOod licensedMaxRateLimit

Two new statistics have been added to show table global command:

• oodMessageCurrentStatistics
• oodMessageIntervalStatistics

Command Syntax:

To configure licensed Out-Of-Dialog rate limit:

% set global sipOod licensedMaxRateLimit

Command Parameters

Command Syntax:

To display the Out-Of-Dialog Current Statistics:

 % show status global oodMessageCurrentStatistics

Command Parameters

Command Syntax:

To display the Out-Of-Dialog Interval Statistics:

% show status global oodMessageIntervalStatistics

Command Parameters

SBX-65402 RTCP Relay Feature With RTCP Generation

The RTP Control Protocol (RTCP) in conjunction with RTP, provides the report of PDUs exchanged between the source and the destination. It provides feedback on the quality of the data distribution. The RTCP monitors the transmission statistics and Quality of Service (QoS) status of the media streams and aids synchronization of multiple streams.

When the SBC generates an RTCP packet toward the outgoing direction, it relays the received RTCP packets from one leg to another leg. The SBC supports  RTCP monitoring and generates RTCP for pass through calls regardless of the leg where the RTCP is received. The SBC generates RTCP on one leg, even if other leg sends RTCP, without any dependency on the RTCP-related configuration on the other leg.

Command Syntax

 % set profiles media packetServiceProfile <unique_profile_name>
    rtcpOptions <disable | enable>

Command Parameters

SBX-65508 Domain-based Licensing on SBC SWe Cloud

SBC SWe cloud deployments support a domain-based licensing model referred to as network-wide domain licensing (NWDL). In contrast to node-locked licensing, a domain license is tied to an administrative domain rather than the hardware ID for a specific host server or the UUID for a specific node instance. A domain license is bound to the domain through public/private key-pairing and it defines the features and capacity allowed for all nodes within the domain. NWDL provides flexibility in cloud environments where the number and placement of nodes sometimes varies.

Command Syntax

To set license mode.

% set system licenseMode mode <domain | legacy | network>

To set license restrictions while in domain license mode. 

% set system licenseRequired <licensed feature key> maxCount <2-1000000, or "unlimited">

To display information about the domain license bundles loaded into the system.

> show status system licenseDomainBundleInfo  or
> show table system licenseDomainBundleInfo 

Command Parameters

SBX-67789 Disable/OOS per Peer with DNS query

The SBC is enhanced to disable/set Out of Service the server at the IP peer level. In order to do so, your network must know the server IP address of the peer.

The SBC uses a Domain Name Server (DNS) server to resolve the Fully Qualified Domain Name (FQDN), and obtains multiple IP peer addresses. After a carrier notifies your network that a particular server has an issue and is out of service, your network server's peer mode is set to Out Of Service

This feature provides the flexibility to block peers individually within a trunk group. The can be set to out of service, rejecting both incoming and outgoing calls.

Command Syntax

This command controls the feature flag. When enabled, then only other commands are visible.

% set addressContext <adddress context name> zone <zone name> advancePeerControl <disabled | enabled>

Command Syntax

This commands allows the user to accept or reject call through that IP peer.

% set addressContext <adddress context name> zone <zone name> ipPeer <ip peer name> mode <inService | outOfService>

Command Syntax

This command allows the user to terminate calls immediately or after some specified time.

% set addressContext <adddress context name> zone <zone name> ipPeer <ip peer name> action <dryUp | force>

Command Syntax

This command allows the user to select range timeout values to terminate the call.

%  set addressContext <adddress context name> zone <zone name> ipPeer <ip peer name> dryUpTimeout <1-1440 mins>

Command Syntax

This command allows user to block incoming /outgoing calls based on the selected direction.

% set addressContext <adddress context name> zone <zone name> ipPeer <ippeer name> blockDirection <bothways | incoming | none | outgoing>

Command Parameters

SBX-67797 Multiple Bindings per SIP line (several phones share same number)

When a subscriber registers from multiple devices with the same username, there is an inherent issue on the private side of the SBC. In Access mode, the SBC traditionally does not manipulate the username for the AOR, but does manipulate the host portion. The host portion is changed to the private side IP of the SBC when sending to the Registrar. If a subscriber registers from multiple devices it causes the same AOR to be created from the SBC to the registrar.

To make this unique, the SBC inserts a parameter called reg-info and inserts a unique value in this parameter. Some registrars do not cache the parameters inserted by the SBC which causes this use case to fail.

To remediate this type of failure, the SBC privately assigns a unique new value to the username. The SBC maintains a mapping from this unique username value on the private side, and the original username on the public side.

Command Syntax

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

Command Parameters

SBX-67830 Remove enumdi Parameter Inserted in Egress R-URI after ENUM Query from PSX

In its default behavior, the SBC adds an enumdi (ENUM dip indicator) parameter to the outgoing Request URI when the PSX performs an ENUM query. Some peering carriers do not support this parameter and want the option to not have the SBC insert the parameter the egress Request URI.  A global flag, egressRemoveEnudmi, controls whether the parameter is present. By default the flag is disabled to maintain the SBC default behavior. When the egressRemoveEnudmi flag is enabled the SBC does not add an enumdi parameter even if the PSX performs an ENUM query.

The CLI change consists of adding a new option within the existing, global sipSigControls options.

Command Syntax

% set global signaling sipSigControls egressRemoveEnudmi <disabled | enabled>

Command Parameters

SBX-69821 Update MetaVariables Table to Add New SIP Signaling Port

The system metaVariableDynamic table is added to allow adding the meta variable information on an already instantiated SBC instance with the following parameters:

• ceName
• name
• value 

Command Syntax

set system metaVariableDynamic ceName < name of the SBC instance> name <name of the metavariable> value <metavariable>

Command Parameters

Deprecated CLI

revertSoftwareUpgrade

commitSoftwareUpgrade