You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 46 Next »

In this section:

New CLI in 8.2.0R0

Info

Default values are enclosed in square brackets [ ].

SBX-41671 TTY/TDD Interworking Support for RFC-4103 and/or RFC-4351

The parameter generateRtcpForT140IfNotReceivedFromOtherLeg is added to packetServiceProfile rtcpOptions rtcp. When the parameter is set to enable, the SBC generates RTCP for T140 media streams if RTCP is not received from peer.

For more information, refer to the following pages:

Command Syntax

Note

To configure this feature, ensure that the t140Call parameter is set to enable, by using the following syntax:

% set profiles media packetServiceProfile <profile_name> flags t140Call enable

To configure the parameter generateRtcpForT140IfNotReceivedFromOtherLeg, use the following syntax:

set profiles media packetServiceProfile <packetServiceProfile_name: INGRESS>
	rtcpOptions 
		rtcp <disable | enable> 
			generateRtcpForT140IfNotReceivedFromOtherLeg <disable | enable>

Command Parameters

Parameter Descriptions

ParameterLength/RangeDefaultDescriptionM/O
generateRtcpForT140IfNotReceivedFromOtherLeg

N/A

disable

The SBC generates RTCP for T140 media streams if RTCP is not received from peer.

  • disable (default)
  • enable
O

SBX-62459 Support for Public-key-Based Peer Authentication Method for IPSec

The SBC is enhanced to support a Public Key-based peer authentication method for IPSec on SBC. In past releases, the SBC used a Preshared key-based authentication method for Peer authentication during IKE negotiation for establishing IKE and IPSec Security associations. To meet Common Criteria certification requirements, the SBC is now capable of using x.509 digital certificates for Peer authentication. Note: Not currently supported on SBC Cloud and D-SBC platforms.

For more information, refer to IPsec Peer - CLI.

Command Syntax

% set addressContext default ipsec peer <peerName> authType <psk | rsaSig>
% set addressContext default ipsec peer <peerName> localCertificate <sbcCertName>
% set addressContext default ipsec peer <peerName> remoteCertificate <peerCertName>
% set addressContext default ipsec peer <peerName> remoteCaCertificate <caCertName1>

 

Command Parameters

Parameter
Default
Description
M/O
authTypepsk

The authentication method – preshared key (psk) or rsa signature (rsaSig).

M
localCertificate n/aThe name of local (SBC) Certificate.M
remoteCertificate n/aThe name of remote (IPSec Peer) Certificate.M
remoteCaCertificate n/aThe name of remote CA Certificate referred by the IPSec peer entry.O

 

SBX-67554 LCQ CC/SIP Issue - Multiple Call Transfer - SIP Layer Stops Responding

The SBC is enhanced with the parameter maxNumTransfers under the object global signaling.

For more information, refer to Signaling - Global - CLI and Show Table Global.

Command Syntax

To configure maxNumTransfers, use the following syntax:

% set global signaling maxNumTransfers <10-100>

Command Parameters

Parameter Description

ParameterLength/RangeDefaultDescriptionM/O
maxNumTransfers

10-100

10Specifies the maximum number of transfers (10-100) allowed within a call; default is 10.O

Configuration Examples

To configure maxNumTransfers, use the following example:

% set global signaling maxNumTransfers 30

To display the maxNumTransfers, use the following example:

  • In the "configure" mode:

    % show global signaling maxNumTransfers
    maxNumTransfers 30
  • In the "display" mode (when you exit the "configure" mode):

    > show table global signaling
    maxNumTransfers 30;
    messageManipulation {
        inputAdapterProfile  DD1;
        outputAdapterProfile DD1;
    }
    sipPeerOverloadControl {
        samplingPeriod  2;
        discardPeriod   2;
        stepDownGain    100;
        rejectThreshold 1;
    }
    sipSigControls {
        registrarSupportContactParam enabled;
        maxPduSizeValue              pdusize15kb;
    }
    
    

 

SBX-68878 CDR for SIPREC Sessions

The SBC is enhanced to support a new parameter "Generate Recording CDR" to the OAM > Accounting > Admin. When the "Generate Recording CDR" parameter is enabled, the SBC generates a Recording-CDR. The selected CDR is placed in the .ACT files along with the other call and Event CDRs. All the file size and CDR count rules of the existing CDRs apply to the Recording CDRs. 

For more information, refer to Packet Service Profile - CLI.

 

Command Syntax

 

% set oam accounting admin generateSipRecordingCdr <disabled | enabled>

 

 Command Parameters

Parameter Name

Default Value

Optional or Required?

Parameter Description

 generateSipRecordingCdr

disabled

Optional

Enables or disables generation of CDRs for recording SIP calls.

 

 

SBX-70465 STIR/SHAKEN: Option to Signal Verification Failures in Backward Provisional Responses

The ATIS specification defines an optional capability to signal verification failures in backward provisional responses. If a terminating carrier B fails verification for an originating carrier A subscribers, but continues to deliver the call to the carrier B called party, carrier A will have no way to know. The terminating carrier can use failed verification to indicate robocalling status to the called party. In this case, carrier A has no way to know that their subscribers' calls are being flagged as robocalls to the terminating party.

The capability described in the ATIS specification solves this issue if carrier A has tools in place to find these indications in the SIP messaging.

Trunk-group-level SIP cause value reporting should include counts for each unique case value transmitted. These statistics already exist for the Reason header transmitted at the end of the call; however, this would additionally count the cause values send in the 18x/200 for STIR/SHAKEN.

New STI Profile flag overWriteReasonCodeIn4xxto6xx added regarding 4xx-6xx handling.

For more information, refer to STI Profile - CLI.

Command Syntax

Example
% set profiles services stiProfile <profile_name> overWriteReasonCodeIn4xxto6xx <disabled | enabled>

 

Command Parameters

ParameterLength/RangeDefault

Description

M/O
overWriteReasonCodeIn4xxto6xx

1

disabled

This parameter controls whether to Insert Reason Code from PSX or not in case of 4XX/5XX/6XX responses

  • disabled
  • enabled
O

 

SBX-70938 RTCP for T.140 Pass-through

A parameter, t140RtcpMonitorInterval, is added under mediaRTCPControl to define the RTCP monitoring interval. This enables the SBC to wait for an RTCP packet from peer before starting RTCP towards T.140 endpoint with the following PSP flag enabled.

A flag, generateRTCPForT140IfNotReceivedFromOtherLeg, is added under RTCP Options in the Packet Service Profile so that the SBC is able to configure specific trunk groups to generate RTCP on T.140 to T.140 passthrough media streams. The SBC will start generating RTCP for T.140 stream if RTCP is NOT received from the endpoint. 

For more information, refer to Packet Service Profile - CLI and Media System - CLI.

 

Command Syntax

% set system media mediaRtcpControl t140RtcpMonitorInterval 6
% set profiles media packetServiceProfile DEFAULT rtcpOptions generateRtcpForT140IfNotReceivedFromOtherLeg enable

 

Command Parameters

t140RtcpMonitorInterval

ParameterLength/RangeDefaultDescriptionM/O
t140RtcpMonitorInterval 

 

2-20 seconds

 

6 seconds

Defines the interval for which the SBC monitors the RTCP packets for T140 stream from endpoints. If RTCP is not received within this interval, the SBC starts RTCP generation.

  1. This configuration applies only to the T140 stream.
  2. This configuration shall take effect only if corresponding PSP flag "generateRtcpForT140IfNotReceivedFromOtherLeg" is enabled.
O

generateRtcpForT140IfNotReceivedFromOtherLeg

ParameterLength/RangeDefaultDescriptionM/O
generateRtcpForT140IfNotReceivedFromOtherLeg 

 

 Enable/Disable

Disabled

Use this flag to configure specific trunk groups to generate RTCP for text pass-through media streams.

This flag can be provisioned if RTCP is "enabled" under rtcpOptions.

  • disable (default) – RTCP is not generated for T.140 media stream on this leg.
  • enable – Enable flag to generate RTCP for T.140 media streams, provided RTCP is not received from other peer.
O
 

 

 

SBX-75174 - Generate or Replace SSRC Values for Calls Toward a Kandy Link WebRTC Gateway

The synchronization source (SSRC) identifier uniquely identifies media streams within an RTP session and is included in SDP signaling when establishing or modifying media sessions. The WebRTC specification requires that the SSRC value in an RTP stream match the SSRC sent in the SDP. However some endpoints, such as PSTN gateways, are not capable of generating SSRC values so they are not present in the SDP. Other endpoints change the SSRC during call hold/resume scenarios. The SBC provides two flag parameters to the Packet Service profile to determine whether the SBC generates and updates the SSRC and related attributes.

For more information, refer to Packet Service Profile - CLI.

Command Syntax

The SBC adds the following two flags to the Packet Service profile. 

% set profiles media packetServiceProfile <profile name> flags
      generateAndSignalSSRCAndCname <disabled | enabled>
      allowMidCallSSRCModification <disabled | enabled>

The SBC only allows mid-call modifications to the SSRC if it is generating the SSRC. Therefore, the first parameter, generateAndSignalSSRCAndCname, must be enabled for the second parameter, allowMidCallSSRCModification, to become available.

Command Parameters

ParameterDescription

generateAndSignalSSRCAndCname

Enable this flag to generate an SSRC value and associated attributes and include them in SDP signaling and RTP/RTCP streams. Options are:

  • disabled (default)
  • enabled

Note: This flag takes precedence over the Packet Service Profile ssrcRandomize flag.

allowMidCallSSRCModification

Enable this flag so that in call hold/resume scenarios the SBC modifies the SSRC and associated attributes after the call resumes. The SBC sends both the previous and updated SSRC in SDP signaling and includes the new SSRC iin RTP/RTCP streams. Options are:

  • disabled (default)
  • enabled

Note: You must enable the generateAndSignalSSRCAndCname flag before you can enable this flag.

Note: If you enable the IP Signaling profile common IP attributes flag minimizeRelayingOfMediaChangesFromOtherCallLegAll, you must also enable the relayDataPathModeChangeFromOtherCallLeg flag to have the SSRC modification processing take effect.

 

 

SBX-75865 Alarm Generation when SBC Receives RCODE Except for 0

The rcodeErrorMonitorTimer parameter is added to the DNSGroup configuration to support monitoring timer interval which the SBC Core uses to monitor RCODE errors.

 For more information, refer to DNS Group - CLI

Command Syntax

% set addressContext <address_context_name> dnsGroup <dnsgroup> rcodeErrorMonitorTimer <rcode_error_monitor_timer>

Command Parameters

Rcode Error Monitor Timer

ParameterLength/RangeDefaultDescription
rcodeErrorMonitorTimer0 - 60 minutes0 minutes

Configure the RCODE error monitor timer interval to allow the 

Unable to show "metadata-from": No such page "_space_variables"
to monitor RCODE errors.

When the timer value is 0, this feature is disabled.


SBX-76436 - Increase CDR Retention with Compression

The SBC is enhanced to allow writing accounting files containing CDRs into a compressed format. The compressed files are retained for a user-specified time period; thereafter, they are automatically deleted after a specified number of days. The compressed files are stored in the evlog directory or another directory that you specify.

 For more information, refer to Event Log - CLI

 

Command Syntax

Example
% set oam eventLog typeAdmin acct
    compressionSupport <both | none | only>
    compressionDaysToKeep <1 .. 7>
    compressionCleanupDirectory

 

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O
compressionSupport N/A

Type of compression.

  • both The SBC generates both compressed and uncompressed CDR files
  • none For backward compatibility, uncompressed CDR files
  • only The SBC generates compressed CDR files
 
compressionDaysToKeep1-75The number of days to keep compressed files before deleting. 
compressionCleanupDirectoryN/AN/AAlternate directory name (containing no slashes) under the log file directory from which compressed files are removed after compressionDaysToKeep days elapse. 

 

SBX-76610 Selection Feature for ARS Recovery Algorithm

The following is the full syntax to create a SIP ARS profile, including the new recoveryAlgForTimeouts and recoveryAlgForNoRetryAfter options and their parameters for selecting the ARS recovery algorithm for each blacklist algorithm.

For more information, refer to SIP ARS Profile - CLI.

 

Note

Ensure the ARS profile is configured with the recovery algorithms specified in the recovery flags.

 

Command Syntax

 set profiles services sipArsProfile <Profile Name> recoveryAlgForTimeouts < probe | timer | none >
 set profiles services sipArsProfile <Profile Name> recoveryAlgForNoRetryAfter < probe | timer | none >
Example
% set profiles services sipArsProfile <profile name>
   blkListAlgRetryAfterType sip-503
   blkListAlgTimeoutsDuration <1-3600>
   blkListAlgTimeoutsNumTimeouts <1-3600>
   blkListAlgTimeoutsType sip-invite
   blkListAlgorithms <retryafter | timeouts | noRetryAfer>
   blkListAlgNoRetryAfterNum503 <1-3600>
   blkListAlgNoRetryAfterDuration <1-3600>
   failureResponseCodes <400-699 | all |all4xx | all5xx | all6xx>
   midDialogArsScreenLevel <always | never | onlyIfNotBlackListDueto503>
   recoveryAlgProbeDuration <1-3600>
   recoveryAlgProbeInterval <1-600>
   recoveryAlgProbeMethod sip-options
   recoveryAlgProbeNumResponses <1-32>
   recoveryAlgTimerDuration <1-3600>
   recoveryAlgorithm <probe|timer>
   recoveryAlgForTimeouts <probe|timer|none>
   recoveryAlgForNoRetryAfter <probe|timer|none>

Command Parameters

ARS Recovery Algorithm Parameter

ParameterLength/RangeDefaultDescription
recoveryAlgForTimeouts none

Specifies the type of recovery algorithm for the endpoints blacklisted with timeouts algorithm.

  • probe - use probe as recovery algorithm for the endpoints blacklisted with timeouts algorithm.
  • timer - use timer as the recovery algorithm for the endpoints blacklisted with timeouts algorithm.
  • none - use the recovery algorithm specified in the ARS profile.

Note: When the flag is set to none, the

Unable to show "metadata-from": No such page "_space_variables"
continues with the default behavior which is specified in the recoveryAlgorithm flag.

recoveryAlgForNoRetryAfter none

Specifies the type of recovery algorithm for the endpoints blacklisted with 503 noRetryAfter algorithm.

  • probe - use probe as the recovery algorithm for the endpoints blacklisted with 503 noRetryAfter algorithm.
  • timer - use timer as the recovery algorithm for the endpoints blacklisted with 503 noRetryAfter algorithm.
  • none - use the recovery algorithm specified in the ARS profile.

Note: When the flag is set to none, the

Unable to show "metadata-from": No such page "_space_variables"
continues with the default behavior specified in the recoveryAlgorithm flag.

 

SBX-85716  Re-initiate Pre-condition Negotiation Towards Ingress

Two new parameters are added to SIP trunk group signaling and are shown in the context of the complete command syntax.

  • performPrecondtionRenegotiation: to re-initiate precondition procedure when the 
    Unable to show "metadata-from": No such page "_space_variables"
    changes the ingress side SDP due to 18x/200 OK or UPDATE received from the egress side.
  • preferUPDATEOverReINVITE: to use UPDATE instead of Re-INVITE on the ingress to communicate SDP, when the call goes to the confirmed state.

For more information, refer to:


Command Syntax

Example
% set addressContext default zone <zone_name> sipTrunkGroup <siptrunkgroup_name> signaling preferUPDATEOverReINVITE <enabled | disabled>
% set addressContext default zone <zone_name> sipTrunkGroup <siptrunkgroup_ingress_name> signaling performPrecondtionRenegotiation 
<enabled | disabled>

Command Parameters

Rcode Error Monitor Timer

ParameterLength/RangeDefaultDescription
preferUPDATEOverReINVITENAdisabled

Enable this flag on the ingress trunk group to allow the 

Unable to show "metadata-from": No such page "_space_variables"
to use UPDATE instead of Re-INVITE to communicate SDP towards ingress, when the call is in the confirmed state.

The options include:

  • disabled
  • enabled

Note:  This is not applicable when the dialog transparency flag or the updatedAnswerIn200Ok flag is in enabled state on the

Unable to show "metadata-from": No such page "_space_variables"
.

performPrecondtionRenegotiationNAdisabled

Enable this flag on the ingress trunk group to allow the 

Unable to show "metadata-from": No such page "_space_variables"
to renegotiate the precondition on the ingress when there is a change in SDP during early dialog phase or whenever the call goes to confirmed state. The
Unable to show "metadata-from": No such page "_space_variables"
supports this flag for SIP gateway-gateway call.

The options include:

  • disabled
  • enabled

Note:

This is not applicable when the dialog transparency flag or the updatedAnswerIn200Ok flag is in enabled state on the
Unable to show "metadata-from": No such page "_space_variables"
.
 
 


SBX-86008 Cloud SBC Avalanche Fault - Detection and Control

Packets that cause a direct SBC fault can lead to a catastrophic failure of an SBC service, which is known as a packet-stimulated fault avalanche. These packets appear for various reasons, such as: the SBC adds a new Session Initiation Protocol (SIP) endpoint, upgrades or replaces a peering endpoint or gateway (GW), changes a configuration on a peer, or introduces a new call scenario. The SBC does not currently check for double faults, which is when the SBC has a failover and then another failover. Double faults cause call loss.

For more information, refer to  CLI Configure Mode.

Command Syntax

Use the following command to set and configure the faultAvalancheControl parameter.

% set system faultAvalancheControl callIdThreshold <0-999> calledPartyThreshold <0-999> callingNCalledPartyThreshold <0-999> callingPartyThreshold <0-999> sourceIpThreshold <0-999> faultRecAgeingTimeOut <15-60>

Use the following command to enable or disable the faultAvalancheControl parameter.

% set system faultAvalancheControl facState <disabled | enabled>

Command Parameters

faultAvalancheControl Parameter

ParameterLength/RangeDefaultDescriptionM/O
faultAvalancheControlN/AN/A

This parameter controls the fault avalanche issue.

O
callIdThreshold0-9990

<0-999> - The number of crashes the specific call-ID causes, after which the SBC drops the SIP messages that carry the same call-ID.

O
calledPartyThreshold0-9993

<0-999> - The number of crashes the specific called party causes, after which the SBC drops the SIP messages that carry the same called party address.

O
callingPartyThreshold0-9993

<0-999> - The number of crashes the specific calling party causes, after which the SBC drops the SIP messages that carry the same calling party address.

O
callingNCalledPartyThreshold0-9991<0-999> - The number of crashes the specific calling & called party causes, after which the SBC drops the SIP messages that carry the same calling and called party address.O
faultRecAgeingTimeOut15-6030<15-60> - Configure this parameter with the timeout (in minutes) of the fault record aging.O
sourceIpThreshold0-9995<0-999> - The number of crashes the SIP messages from a specific source IP address cause, after which the SBC drops the SIP messages from the same source IP address.O
facState N/Adisabled

Use this flag to enable or disable the Fault Avalanche Control feature. When you update this flag from enabled to disabled, the system deletes the existing fault records and blocking entries. This update does not impact the fault records that this system might have previously broadcast to other SBCs in the cluster.

  • disabled (default) - The SBC does not perform tracking or blocking.
  • enabled
O
 

SBX-86658 Offer-Answer Timer Configuration

In specific call scenarios, the SBC treats the Offer-Answer (OA) as a MODIFY Offer-Answer cycle, but the peer treats it as an INITIAL Offer-Answer cycle. According to RFC 3261, the response from the peer is expected within 300 seconds. The SBC, however, assumes a 20-second response, and therefore any delay in the response from the peer which exceeds of 20 seconds causes call failure.

Currently, the internal Offer-Answer (OA) timer value is fixed and cannot be configured. To overcome this limitation, the SBC is enhanced with a new parameter offerAnswerTimer to configure this OA timer.

For more information, refer to Signaling - Global - CLI

Command Syntax

% set global signaling sipSigControls offerAnswerTimer 
Possible completions:
<Enter offer answer timer value in range of (10..300) in seconds.> (20):

Command Parameters

Offer Answer Timer

ParameterLength/RangeDefaultDescriptionM/O
offerAnswerTimer

10 - 300 seconds

20 seconds

Specify the number of seconds for the 

Unable to show "metadata-from": No such page "_space_variables"
to wait for the Offer-Answer handshake to complete before timing out.    

Once configured, the 

Unable to show "metadata-from": No such page "_space_variables"
uses this value for all subsequent calls.

For backward compatibility, set the offerAnswerTimer to its default value for SIP signaling gateway.

Note:

 The offerAnswerTimer flag applies to calls modified using a Re-INVITE, but not for an UPDATE.

M

SBX-86789 SBC Should Create TLS Connection Based on Contact Header

The SBC provides the following new SIP trunk group parameter to specify whether to use the Contact header information instead of the source IP address when routing a call to an access user over TLS transport. 

For more information, refer to SIP Trunk Group - Signaling - CLI

Command Syntax

 

% set addressContext <address context>  zone <zone> sipTrunkGroup <trunk group name> signaling honorContactInRegisterForTLSCalls <disabled | enabled>

 

Command Parameters

Parameter
Description

honorContactInRegisterForTLSCalls

Use this flag to specify where the SBC directs access calls from the internal network to users in the access network when the call is over TLS transport. The options are:

  • disabled (default) - Maintains the default SBC behavior to direct calls to the source IP address when the target user registered.
  • enabled - Directs the call to the address the SBC stored from the Contact header that was part of the user's REGISTER request.

 

SBX-87239 Response Code Change When SBC Fails a DNS Query 

 When the SBC fails a DNS query, it generates a 503 or 500 error response. These error codes are now mapped to a configurable response code. A new enum - DnsRcodeError - has been added to internalCause in sonusSipInternalCauseMapProfile.yang to provide mapping entry in existing InternalSipCauseMapProfile profile.

For more information, refer to Show Table Global. and CPC to SIP Cause Map Profile - CLI.

 

Command Syntax

% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <profile_name> causeMap <CPC cause value> DnsRcodeError


Command Parameters

 

Parameter
Length/Range
Default
Description
M/O
dnsRcodeError

300-606

N/A

Allows 500 and 503 error code mapping to a configurable response code.

Mandatory

 

SBX-88542 Prefix-based TG Selection using SMM

The SBC adds support for using  SIP Message Manipulation (SMM) to enable secondary selection of an ingress trunk group. This processing requires two new SMM operations and SIP Param Based Action profiles.

For more information, refer to SIP Adaptor Profile - CLI.

Command Syntax

The following new operations are supported in SMM sipAdaptorProfiles.

%  set profiles signaling sipAdaptorProfile <profileName> rule <rule index> action <action index> operation 
        storeSipParam
        storeProfileName

The SIP Param Based Action profile is supported.

%   set profiles signaling sipParamBasedActionProfile <profileName> 
          action <none | selectTG>
          entry <0 to 2056>
             trunkGroupName <trunk group name>
             matchType 
               full 
                 param <parameter value>
               none
               range 
                 rangeEnd <end of parameter range>
                 rangeStart <start of parameter range>
               regexp
                 paramRegexp <regular expression>

Command Parameters

The following table describes the new SMM operations.

ParameterDescription

storeSipParam

SMM operation that extracts a specified value (header, parameter, token) from the incoming SIP message to compare to mapping defined in a sipParamBasedActionProfile in order to select a new ingress trunk group.

storeProfileName

SMM operation that stores the name of a sipParamBasedActionProfile to use in selecting a new ingress trunk group.


The following table describes the parameters in the sipParamBasedActionProfile.

ParameterLength/RangeDescription

sipParamBasedActionProfile
<profileName>

up to 23 characters

Name for the sipParamBasedActionProfile.

action

n/a

Action to be performed by the sipParamBasedActionProfile. Options are:

  • none (default)
  • selectTG

entry

0 to 2056Index value for the entry. A sipParamBasedActionProfile can contain a maximum of 2056 entries.

trunkGroupName

up to 23 charactersThe name of the trunk group to set as the new ingress trunk group if the corresponding entry matches the value extracted with the SMM storeSipParam operation.

matchType

n/a

Type of matching to use when comparing the value extracted with the SMM storeSipParam operation with the corresponding entry. Options are:

  • full - compare against the list of param values defined for the entry. The extracted value must match exactly.
  • none - (default) matching is not done.
  • range - compare against a defined range. The extracted value must be within the range to match.
  • regexp - compare against a defined regular expression. The extracted value must match the regular expression.

param

up to 128 charactersParameter value to compare against when matchType is full. More than one param value can be defined for an entry when matchType is full.

rangeEnd

up to 128 charactersEnding value for a range to compare against when matchType is range.

rangeStart

up to 128 charactersStarting value for a range to compare against when matchType is range.

paramRegexp

up to 128 charactersRegular expression to compare against when the matchType is regexp.

 

SBX-88601 SMM: Support Global Configuration

The SBC adds support for applying SIP message manipulation (SMM) profiles (SIP adaptor profiles) at both the global and address context levels and options that control how to execute profiles when they are specified at more than one level.

For more information, refer to Signaling - Global - CLI.


Command Syntax

Global

The following new options specify the names of SIP adaptor profiles to apply at the global level.

% set global signaling messageManipulation
      inputAdapterProfile <profile name>
      outputAdapterProfile <profile name>
Address Context

The following new options specify the names of SIP adaptor profiles to apply to sessions within a specified address context..

% set addressContext <address context> signaling messageManipulation
      inputAdapterProfile <profile name>
      outputAdapterProfile <profile name>
SIP Trunk Group

The following new options specify whether or not to use fixed order execution when multiple SMM profiles apply to a session. When fixed order execution is enabled, you can also specify which of the four profile types to enable and therefore include in SMM processing.

% set addressContext <address context>  zone <zone> sipTrunkGroup <trunk group name> signaling messageManipulation smmProfileExecution 
      none
      fixedOrder 
         addressContext acState <disable | enable>
         global globalState <disable | enable> 
         iptg iptgState <disable | enable>  
         zone zoneState <disable | enable>     

Command Parameters

Global
ParameterLength/RangeDescription

inputAdapterProfile

0-23 characters

<profile name> – Enter the name of a SIP adaptor profile to use globally on inbound messages.

outputAdapterProfile

0-23 characters<profile name> – Enter the name of a SIP adaptor profile to use globally on outbound messages.
Address Context
ParameterLength/RangeDescription

inputAdapterProfile

0-23 characters

<profile name> – Enter the name of a SIP adaptor profile to use for the address context on inbound messages.

outputAdapterProfile

0-23 characters<profile name> – Enter the name of a SIP adaptor profile to use for the address context on outbound messages.
SIP Trunk Group
ParameterDescription

smmProfileExecution

Specifies whether or not to use fixed order processing when more than one SIP adaptor profile applies to messages in sessions associated with the specified SIP trunk group. The options are:

  • fixedOrder - the SBC logically concatenates the rules in all applicable profiles and executes them in the following order: global, address context, zone, SIP trunk group. Rules are treated as though they resided in a single profile and therefore variables set at the beginning of the sequence are accessible to rules that follow in the sequence. Selecting fixedOrder also enables configuring options for each specific level (global, address context, zone, SIP trunk group) to define whether or not to execute the profiles configured at that level. These options are described in the next four rows of this table.
  • none (default) - the SBC does not execute multiple profiles for a session. If configured, the SIP adaptor profile configured for the SIP trunk group takes precedence. If no profile is assigned to the trunk group the SBC executes the zone-level profile.

addressContext acState

Specifies whether the SBC executes the rules in the SIP adaptor profiles assigned at the address context level on messages in sessions associated with the specified SIP trunk group. The options are:

  • disabled - the address-context-level profiles are not applied.
  • enabled (default) - the address-context-level profiles are applied.

This option is only available after you set smmProfileExecution to fixedOrder.

global globalState

Specifies whether the SBC executes the rules in the SIP adaptor profiles assigned at the global level on messages in sessions associated with the specified SIP trunk group. The options are:

  • disabled - the global-level profiles are not applied.
  • enabled (default) - the global-level profiles are applied.

This option is only available after you set smmProfileExecution to fixedOrder.

iptg iptgState

Specifies whether the SBC executes the rules in the SIP adaptor profiles assigned at the SIP trunk group level on messages in sessions associated with the specified SIP trunk group. The options are:

  • disabled - the trunk-group-level profiles are not applied.
  • enabled (default) - the trunk-group-level profiles are applied.

This option is only available after you set smmProfileExecution to fixedOrder.

zone zoneState

Specifies whether the SBC executes the rules in the SIP adaptor profiles assigned at the zone level on messages in sessions associated with the specified SIP trunk group. The options are:

  • disabled - the zone-level profiles are not applied.
  • enabled (default) - the zone-level profiles are applied.

This option is only available after you set smmProfileExecution to fixedOrder.


 

SBX-70005 Relay Changes in PAID as per RFC-5876

A new Services profile, sipAdaptiveTransparencyProfile, is added to configure SIP header transparency for P-ASSERTED-IDENTITY.

For more information, refer to SIP Adaptive Transparency Profile - CLI.


Under sipAdaptiveTransparencyProfile, the following parameters are added:

  • sipMethod
  • sipResponse
  • state
  • triggerHeader
  • action
  • trigger

Command Syntax

% set profiles services
	sipAdaptiveTransparencyProfile <profile_name>
		sipMethod <UPDATE | INVITE>
		sipResponse <180 | 183 | 200>
		state <disabled | enabled>
		triggerHeader <P-ASSERTED-ID>
			action new-value
			trigger value-change
Note

The SIP Method INVITE applies only to "re-INVITE" scenarios, and not "initial INVITE" scenarios.

Command Parameters

Parameter Descriptions

ParameterLength/RangeDefaultDescriptionM/O
sipAdaptiveTransparencyProfile1-23 charactersN/A<profile name> Specifies the profile name for which the SBC passes configured SIP headers "adaptive transparently".O
sipMethod
N/AN/A

Specifies the SIP method for which the SBC performs the configured action, when the configured triggerHeader matches with the received SIP header.

  • UPDATE
  • INVITE 

Note: The SIP Method INVITE applies only to "re-INVITE" scenarios, and not "initial INVITE" scenarios.

M
sipResponseN/AN/A

Specifies the SIP response code for which the SBC performs the configured action, when the configured triggerHeader matches with the received SIP header.

  • 180
  • 183
  • 200
M
stateN/Adisabled

The administrative state of the SIP Adaptive Transparency Profile.

  • disabled (default)
  • enabled
O
triggerHeaderN/AN/A

Specifies the SIP header which, if present in the SIP request/method or response, triggers the configured action.

  • P-ASSERTED-ID
M
actionN/Anew-value

The action that the SBC performs, when the SIP header in the request/response matches with the configured triggerHeader.

  • new-value (default)
O
triggerN/Avalue-change

The action/process that the SBC initiates, when the SIP header in the request/response matches with the configured triggerHeader. The value for this parameter acts as an indication for the configured action.

  • value-change (default)
O


SBX-85818 + SBX-85655 Support for SIP-ISUP

The CLI changes are as follows:

  • The following profiles are added under the object profiles signaling:
    • calledPrefixMatchProfile
    • carrierCodeToIoiMappingProfile
    • ioiToCarrierCodeMappingProfile
    • sipJJ9030InterworkingProfile
      For information on the parameters associated with each of the profiles, see the sub-section Command Syntax.
  • The following parameter is added under the object profiles signaling NNIProfile:
    • contractorNumInterworking
  • The following profiles are added under the object addressContext zone sipTrunkGroup signaling:
    • calledPrefixMatchProfile
    • sipJJ9030InterworkingProfile

For more information, refer to the following pages:

Command Syntax

To configure the signaling profile calledPrefixMatchProfile, use the following syntax:

% set profiles signaling
	calledPrefixMatchProfile <called_prefix_match_profile_name: 1-23 characters>
		prefixMatch 
			<stringPattern: 1-12 digits, 'X' or 'x' characters>
			<startPosition: 0-11>
			<digitLength: 1-30>

 

To configure the signaling profile carrierCodeToIoiMappingProfile, use the following syntax:

% set profiles signaling
	carrierCodeToIoiMappingProfile <carrier_code: 4 digits [0-9]>
		accessParam <class | type>
		accessValue <access_value_string: 1-64 characters>
		ioi <inter_operator_identifier_string: 1-128 characters>

 

To configure the signaling profile ioiToCarrierCodeMappingProfile, use the following syntax:

% set profiles signaling
	ioiToCarrierCodeMappingProfile <inter_operator_identifier_string: 1-128 characters>
		carrierCode <carrier_code: 4 digits [0-9]>

 

To configure the signaling profile sipJJ9030InterworkingProfile, use the following syntax:

% set profiles signaling
	sipJJ9030InterworkingProfile <sip_JJ9030_Interworking_Profile_name: 1-23 characters>
		addUserEqualPhoneforDivHiInterworking <disabled | enabled>
		bciCalledPartyCategory <noIndication | ordinary | payphone | spare>
		bciChargeIndicator <charge | noCharge | noIndication | spare>
		bciTerminatingIsdnAccess <isdn | nonIsdn>
		chargeAreaInformation <charge_area: 5 digits [0-9]>
		origIoi <originating_inter_operator_identifier_string: 1-128 characters>
		originatingCarrierCode <originating_carrier_code: 4 digits [0-9]>
		setHiPresentationRestricted <disabled | enabled>
		sipFlavor
			JJ9030
			SIP-T
			SIP-ttc-charging-params
		termIoi <terminating_inter_operator_identifier_string: 1-128 characters>

 

To configure the parameter contractorNumInterworking under the profile NNIProfile, use the following syntax:

% set profiles signaling NNIProfile <nni_profile_name>
	contractorNumInterworking <disabled | enabled>

 

To attach the signaling profiles calledPrefixMatchProfile and sipJJ9030InterworkingProfile with sipTrunkGroup, use the following syntax:

% set addressContext <address_context_name> zone <zone_name> sipTrunkGroup <SIP_TG_name> signaling
	calledPrefixMatchProfile <called_prefix_match_profile_name>
	sipJJ9030InterworkingProfile <sip_JJ9030_interworking_profile_name>
Tip

Create the profiles calledPrefixMatchProfile and sipJJ9030InterworkingProfile before attaching them with sipTrunkGroup.

Command Parameters

The parameter descriptions for profiles signaling calledPrefixMatchProfile are as follows:

Parameter Description - calledPrefixMatchProfile

ParameterLength/RangeDefaultDescriptionM/O
calledPrefixMatchProfile1-23 charactersN/A

<profile_name> - The name of the Called Prefix Match profile.

Note: The SBC allows configuring a maximum of 10 calledPrefixMatchProfile(s).

M
prefixMatchN/AN/A

Use this parameter to configure the prefix that the SBC matches for the called number.

  • <stringPattern> - The regex pattern for the matched string (1-12 digits, 'X' or 'x' characters).
  • <startPosition> - The position of the string (0-11) from which the matching starts.
  • <digitLength> - The maximum number of digits from the start position that can exist in the string for it to be considered as a match. Ensure that the total number of digits in the string is less than or equal to the sum of the values of startPosition and digitLength. The digitLength allows for a maximum of 30 digits.
 M
 

The parameter descriptions for profiles signaling carrierCodeToIoiMappingProfile are as follows:

Parameter Description - carrierCodeToIoiMappingProfile

ParameterLength/RangeDefaultDescriptionM/O
carrierCodeToIoiMappingProfile

4 digits (0-9)

N/A

<carrier_code> - Specifies the carrier code (4-digit numeric string consisting of digits in the range 0-9) mapped to Inter Operator Identifier.

Note: The SBC allows configuring a maximum of 200 entries for each carrierCodeToIoiMappingProfile.

M
accessParamN/AN/A

Specifies the access parameters for the carrier.

  • class
  • type
M
accessValue1-64 charactersN/ASpecifies the access value string associated with the accessParam chosen for the carrier.M
ioi1-128 charactersN/ASpecifies the Inter Operator Identifier (IOI) string for the carrier.M
 

The parameter descriptions for profiles signaling ioiToCarrierCodeMappingProfile are as follows:

Parameter Description - ioiToCarrierCodeMappingProfile

ParameterLength/RangeDefaultDescriptionM/O
ioiToCarrierCodeMappingProfile

1-128 characters

N/A

<profile_name> - Specifies the Inter Operator Identifier (IOI) string mapped to the carrier code.

Note: The SBC allows configuring a maximum of 200 entries for each ioiToCarrierCodeMappingProfile.

M
carrierCode4 digits (0-9)N/A<carrier_code> - Specifies the carrier code (4-digit numeric string consisting of digits in the range 0-9) mapped to Inter Operator Identifier.M
 

The parameter descriptions for profiles signaling sipJJ9030InterworkingProfile are as follows:

Parameter Description - sipJJ9030InterworkingProfile

ParameterLength/RangeDefaultDescriptionM/O
sipJJ9030InterworkingProfile

1-23 characters

N/A

<profile_name> - The name of the SIP JJ-90.30 Interworking Profile.

Note: The SBC allows configuring a maximum of 32 sipJJ9030InterworkingProfile(s).

M
addUserEqualPhoneforDivHiInterworkingN/Adisabled

Enable this parameter to add "user=phone" and the "mp" parameter for diversionHistoryInfoInterworking.

  • disabled (default)
  • enabled

For more information on diversionHistoryInfoInterworking, refer to Egress IP Attributes - SIP - CLI.

M
bciCalledPartyCategoryN/AN/A

The Backwards Call Indicators Called Party Category.

  • noIndication
  • ordinary
  • payphone
  • spare

Note: This parameter is mandatory when the parameter sipFlavor is set to SIP-ttc-charging-params.

O


bciChargeIndicatorN/AN/A

The Backwards Call Indicators Charge Indicator.

  • charge
  • noCharge
  • noIndication
  • spare

Note: This parameter is mandatory when the parameter sipFlavor is set to SIP-ttc-charging-params.

O

bciTerminatingIsdnAccessN/AN/A

The Backwards Call Indicators Terminating ISDN Access Indicator.

  • isdn
  • noIsdn

Note: This parameter is mandatory when the parameter sipFlavor is set to SIP-ttc-charging-params.

O

chargeAreaInformation5 digits (0-9)N/AThe Charge Area Information, consisting of 5 digits (0-9).M
origIoi1-128 charactersN/AThe name of Originating Inter Operator Identifier.M
originatingCarrierCode4 digits (0-9)N/A

The Originating Carrier Code, consisting of 4 digits (0-9).

Note: This parameter is mandatory when the parameter sipFlavor is set to JJ9030.

O

setHiPresentationRestrictedN/Adisabled

Set Presentation Indicator as "restricted" for historyInfoInterworking.

  • disabled (default)
  • enabled

For more information on historyInfoInterworking, refer to NNI Profile - CLI.

M
sipFlavorN/AN/A

The flavor of the SIP parameters and procedures used for this interworking profile.

  • JJ9030
  • SIP-T
  • SIP-ttc-charging-params
M
termIoi1-128 charactersN/AThe name of the Terminating Inter Operator Identifier.M
 

 

 

 

The descriptions for new parameters under profiles signaling NNIProfile are as follows:

Parameter Description - New parameters under NNIProfile

ParameterLength/RangeDefaultDescriptionM/O
contractorNumInterworking

N/A

disabled

Enable this parameter to interwork the parameter contractorNumber to/from the ttc-charging-params information in the SIP header P-Charging-Vector.

  • disabled (default)
  • enabled 
M
 

The descriptions for new parameters under addressContext zone sipTrunkGroup signaling are as follows:

Parameter Description - New parameters under sipTrunkGroup signaling

ParameterLength/RangeDefaultDescriptionM/O
calledPrefixMatchProfile

1-23 characters

N/A

<profile_name> - Specifies the Called Prefix Match table associated with this SIP Trunk Group.

O

sipJJ9030InterworkingProfile

1-23 charactersN/A<profile_name> - Specifies the name of the SIP JJ-90.30 Interworking profile associated with this SIP Trunk Group.O


  • No labels