In this section:

These sections describe configuration objects used to configure signaling at the global level. The following diagram depicts a basic signaling configuration.

Call Signaling Configuration Objects

 

Crankback Profile

Use the crankBackProfile parameter to assign a crankback profile at the global level. The CLI syntax is shown below.

Global Crankback Profile Option
% set global signaling crankBackProfile <profile name>

For flexibility, crankback profiles can be configured at three levels: trunk group, zone, and global. By default, the "default" crankback profile is assigned at the SBC global level, while the trunk group and zone level crankback profile settings are initially empty (" "). Thus in the SBC default configuration, trunk groups and zones inherit the default crankback profile from the global level. However, if you configure a profile at the trunk group or zone level, the user-specified profile assigned at the most specific level takes precedence.

Diameter Signaling Controls

Use this object to configure global diameter signaling controls.

Command Syntax

% set global signaling diamSigControls
	addSonusSpecificAVP <disabled | enabled>
	defaultCCF <ipAddress>
	enableRfApp <disabled | enabled>
	generateFailedEventAcr <disabled | enabled>
	maxACRretransmission <0-3>
	rfInterimAccInrvl <0-180>

Command Parameters

Diameter Signaling Control Parameters

Parameter

Length/Range

Description

addSonusSpecificAVP N/A

Enable this flag to send additional CDR information within Ribbon vendor-specific Attribute Value Pairs (AVPs) in Accounting-Request (ACR) messages over the existing Rf Interface.

  • disabled (default)
  • enabled

Note: Refer to Rf Interface Support for AVP details.

defaultCCFUp to 32 characters<ip address> – Specify the IP address to use as the default CCF realm configuration if CCF is not received in the PCFA. (default = 0.0.0.0).
enableRfAppN/A

Use this flag to enable the Rf Accounting application at the system level to send accounting information over Rf Interface. Refer to Rf Interface Support for feature details.

  • disabled (default)
  • enabled
generateFailedEventAcr N/A

Enable the flag to send an ACR for the failed event.

  • disabled (default)
  • enabled
maxACRretransmission0-3
<#> – Set the maximum number of ACR retransmissions to use if the SBC does not receive ACA (default = 3).
rfInterimAccInrvl0-180

<#> – Use this parameter to specify the interim account interval value to send when no interval is received in ACA. Set the value to 0 to not send interim record (default = 30).

Note: If ACA has a different value than rfInterimAccInrvl, this parameter is overwritten.

sigOnlyModeValueN/A

This global option controls whether the SBC is in signaling-only mode.

  • global – Places the SBC in signaling-only mode and automatically enables direct media on all trunk groups and all IPSPs.
  • off (default)

Note: You can only switch the SBC into or out of signaling-only mode when no active calls are present in the system.

Gateway Signaling Timers

This object allows you to configure the signaling timers for the gateway.

Command Syntax

% set global signaling gwSigTimers
   congRelDelay <delay in seconds>
   establish <timer value, in seconds>
   idle <idle time, in hours>
   keepalive <keepalive time, in seconds>
   retry <number of minutes to attempt to recover GW signaling link>
 
% show global signaling gwSigTimers
 
% delete global signaling gwSigTimers

Command Parameters

Global Gateway Signaling Timers Parameters

Parameter

Description

congRelDelay

Delay time (in seconds) before a release is issued for calls rejected due to congestion. (default=0)


establish

The Gateway Signal Channel Establishment Timer (in seconds.) This value applies to all signal channels. (default = 10).

idle

Idle time (in hours) for a GW Signaling Link May before it is taken down. (default = 0).

keepalive

The Gateway Signal Channel Keep-alive Timer (in seconds.) This value applies to all signal channels. (default = 3).

retry

Amount of time (in minutes) the SBC will continue to attempt to recover a GW Signaling Link as long as there are extant stable calls. (default = 60).

H.323 Signaling Timers

This object allows you to configure signaling timers for the node.

Command Syntax

% set global signaling h323SigTimers 
   establish <timer value, in seconds>
   t301 <timer value, in seconds> 
   t302 <timer value, in seconds> 
   t303 <timer value, in seconds> 
   t304 <timer value, in seconds> 
   t310 <T3timer value, in seconds10> 
   tcpConnect <tcpConnect> 

% show global signaling h323SigTimers
 
% delete global signaling h323SigTimers

Command Parameters

Global H.323 Signaling Timers Parameters

Parameter

Length/Range

Description

Default

establish

0-127

The H225 signal channel establishment timer (in seconds). Default value is 4.

4

t301

0-65535

The T301 call timer (in seconds).

180 seconds

t302

0-127

The T302 call timer (in seconds).

15 seconds

t303

0-127

The T303 call timer (in seconds).

4 seconds

t304

0-127

The T304 call timer (in seconds).

20 seconds

t310

0-127

The T310 call timer (in seconds).

10 seconds

tcpConnect

0-127

The TCP connect timer (in seconds).

3 seconds

Command Example

To display the global configuration of all h323SigTimers:

% show global signaling h323SigTimers  
   establish 33;  
   tcpConnect 77;  
   t301 444;  
   t302 33;  
   t303 22;  
   t304 33;  
   t310 33;

Max Num Transfers

Configure the SBC for the maximum number of transfers (10-100) allowed within a call; default is 10.

Command Syntax

% set global signaling maxNumTransfers <10-100>

Command Parameters

Max Num Transfers

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

Command Example

  • To configure maxNumTransfers, use the following example:

    % set global signaling maxNumTransfers 30
% commit
  • 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;
}

SIP Message Manipulation

The SBC supports applying SIP message manipulation (SMM) profiles (SIP adaptor profiles) at the global level. Use the following parameters to assign SIP adaptor profiles that apply globally on ingress or egress. Refer to SIP Message Manipulation for more information on SMM.

Command Syntax

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

Command Parameters

SIP Message Manipulation

ParameterDescription

inputAdapterProfile

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

outputAdapterProfile

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

Command Example

% set global signaling messageManipulation inputAdapterProfile globalInput 
% set global signaling messageManipulation outputAdapterProfile globalOutput
% commit


Signaling Only Mode

The SBC can be configured in a signaling-only mode so that the SBC participates in the exchange of signaling messages that set up a call but does not reserve or allocate any media resources for the session. The media component of the session is handled as direct media between the call participants.

Command Syntax

% set global signaling sigOnlyMode sigOnlyModeValue <global | off>

Command Parameters

Signaling Only Mode Parameter

ParameterDescription

sigOnlyModeValue

This global option controls whether the SBC is in signaling-only mode. The options are:

  • global - places the SBC in signaling only mode and automatically enables direct media on all trunk groups and all IPSPs.
  • off (default)

Command Example

% set global signaling sigOnlyMode sigOnlyModeValue global
commit


SIP IP Peer Stats

Use this flag to configure support for SIP IP Peer Statistics in the SBC.

Command Syntax

% set global signaling sipIpPeerStats <disabled | enabled>

Command Parameters

SIP IP Peer Status

ParameterDescription
sipIpPeerStats

Enable this flag to configure support for SIP IP Peer Statistics in the SBC.

  • disabled (default)
  • enabled

Command Example

  • To configure sipIpPeerStats, use the following example:

    % set global signaling sipIpPeerStats enabled
% commit
  • To display the sipIpPeerStats, use the following example:

    • In the "configure" mode:

      % show global signaling sipIpPeerStats
sipIpPeerStats enabled;

    • In the "display" mode (when you exit the "configure" mode):

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

SIP Peer Overload Control

This object allows you to configure SIP Peer Overload parameters.

Command Syntax

% set global signaling sipPeerOverloadControl 
   discardPeriod <1-10 seconds> 
   rejectThreshold <0-50> 
   samplingPeriod <1-10> 
   stepDownGain <1-200>
% show global signaling sipPeerOverloadControl
  
% delete global signaling sipPeerOverloadControl

Command Parameters

Global SIP Peer Overload Control Parameters

Parameter

Length/Range

Description

discardPeriod

1-10

Discard period (in seconds) for the Peer Overload back-off algorithm. (default = 2).

rejectThreshold

0-50

Specifies the reject threshold (in rejects/sec) for the Peer Overload backoff algorithm. (default = 1).

samplingPeriod

1-10

Specifies the sampling period (in seconds) for the Peer Overload back-off algorithm. (default = 2).

stepDownGain

1-200

Specifies the step-down gain for the Peer Overload back-off algorithm. (default = 100).

displaylevel

1-64

To display different levels of output information in show commands.

Command Example

To display the global configuration of all SIP overload control:

% show global signaling sipPeerOverloadControl  
   samplingPeriod 2;  
   discardPeriod 1;  
   stepDownGain 44;  
   rejectThreshold 33;

SIP Signaling Controls

Use this object to configure SIP signaling control parameters.

Command Syntax

% set global signaling sipSigControls 
	egressRemoveEnudmi <disabled | enabled>
    egressRNParam <disabled | enabled> 
	loopDetectionFeature <disabled | enabled> 
	maxPduSizeValue <pdusize2kb | pdusize3kb | pdusize6kb | pdusize15kb | pdusize32kb | pdusize60kb> 
	multipleContactsPerAor <disabled | enabled>
    regIpLookupPostSwitchover <disabled | enabled> 
    registrarSupportContactParam <disabled | enabled>
    send503DuringSwitchover <disabled | enabled>
	sendDeRegisterContactAsStar <disabled | enabled>
	sendSurrogateUnRegAfterReboot <disabled | enabled>
	sipBulkStatusForSubscribers <disabled | enabled>
	suppressErrorInfoHdr <disabled | enabled>
	surrogateRegisterPacingTime <0-10000>
	ucidNodeId <node_id>
    offerAnswerTimer <10-300>

 % show global signaling sipSigControls
 
% delete global signaling sipSigControls

Command Parameters

Global SIP Signaling Control Parameters

Parameter

Length/Range

Description

egressRemoveEnudmi

N/A

Controls whether the SBC removes the enumdi (ENUM dip indicator) parameter from the egress Request-URI that the SBC inserts when the PSX does an ENUM query. The options are:

  • disabled (default) - The SBC includes the enumdi parameter in the egress Request-URI when the PSX does an ENUM query.
  • enabled - The SBC does not include the enumdi parameter in the egress Request-URI even if the PSX does an ENUM query.

egressRNParam

N/A

Enable this flag to send a Redirecting Number Information Element (RNIE) in the egress leg of the call per RFC3398 when the R-URI and the To header differ.

  • disabled
  • enabled (default)

loopDetectionFeature

N/A

When enabled, the SIP Stack performs loop detection on incoming INVITE messages.

  • disabled – The SIP signaling group processes the INVITE message.
  • enabled (default)

maxPduSizeValue

N/A

The maximum PDU size recognized by the SBC:

  • pdusize2kb – 2,048 bytes
  • pdusize3kb – 3,072 bytes
  • pdusize6kb – 6,000 bytes
  • pdusize15kb (default) – 15,000 bytes
  • pdusize32kb – 32,000 bytes
  • pdusize60kb – 60,000 bytes

multipleContactsPerAor

N/A

Use this flag to support multiple contacts per Address Of Record (AoR).

  • disabled – Only a single contact per Address of Record is supported.
  • enabled (default) – The SBC maintains different RCBs for each new registration and verifies the source IP address and port during Registration Control Block (RCB) lookup.

The SBC supports validating the source IP address and the port even if multipleContactsPerAor flag is disabled. The SBC also supports locating the RCB using the AoR to perform additional validation on the source IP address and port if the parameter requireRegistration is set to "required" or "required-non-priority". This is applicable for both calls and OOD requests that are originated from the IAD.

In case of refresh registration that is originated from a different IP/port, the SBC forwards the request to the registrar and move the sate to "UPDATING". Any calls or OOD requests that are originated from the IAD while the RCB is in updating state must be validated using the previously authenticated IP/port.

When the flag multipleContactsPerAor is enabled, the SBC maintains different RCBs for each new registration. A registration is considered new when the source IP/port of the REGISTER request is different from earlier registration for the same AoR. Any of the registered UEs may initiate a communication on behalf of the AoR, and the SBC fetches the corresponding RCB based on source IP port of the UE.

Note: Refer to Multiple Contacts per AoR feature page for additional details.

Note: Even though the default value of multipleContactsPerAor is "enabled", during an upgrade the value can be either "enabled" or "disabled".

regIpLookupPostSwitchover

N/A

Note: This feature is only applicable for TCP/TLS transports.

After an SBC switchover, the first REGISTER request sent by the UE is not matched to an existing TCP connection on the newly-active SBC. This will eventually lead the UE to become aware of the lost TCP connection, and the UE will then establish a new TCP connection and send an initial REGISTER request using the same IP address but with a different port compared to the TCP connection established before the switchover as the selection of client source port for a new TCP connection is usually ephemeral.

The SBC relays the initial REGISTER request sent by the UE to the Registrar as it creates a new AoR. Thus, the Registrar receives a high rate of REGISTER requests after an SBC switchover.


Enable this flag for the SBC to search for and validate that the initial REGISTER over the new TCP/TLS connection matches the synchronized RCB after a switchover. The SBC checks that the source IP address used for the new connection matches the old one regardless of the port value (It needs to update the port value and only for the first initial REGISTER received after the switchover for an AoR). Afterwards, the check is again based on the IP/port. 

Note: You must enable multipleContactsPerAor to use this flag.

  • disabled (default) 
  • enabled

registrarSupportContactParam

N/A

Enable flag to support parameters in the Contact header:

  • disabled – Parameters in the Contact header are not supported. This value is provided only for backwards compatibility.
  • enabled (default) – Parameters in the Contact header are supported.
send503DuringSwitchoverN/A

Use this flag to control the sending of 503 message during a switchover.

  • disabled – The request is dropped with no 503 messages sent for Invites.
  • enabled (default) – Send 503 message during a switchover.

Note: The Retry-after tag is set to 60 seconds once the 503 message is sent.

sendDeRegisterContactAsStar N/A

Enable this flag to allow the SBC to send the Contact header as a star (*) in DEREGISTER messages if multipleContactsPerAor is disabled.

  • disabled
  • enabled (default)
sendSurrogateUnRegAfterRebootN/A

Enable flag to trigger de-register messages to all AORs configured to use the Surrogate Registration feature after a reboot.

  • disabled (default)
  • enabled
sipBulkStatusForSubscribersN/A

(For S-SBC / I-SBC in 1:1 deployments only)

Enabling sipBulkStatusForSubscribers gives you the ability to collect status files for the following after performing three dump requests over CLI or RESTCONF API:

  • Status of all Active registered endpoints. 
  • The Deleted Registers table, which includes the last deleted (or expired) registered endpoints.
  • All subscriptions generated by the SBC – specifically, sipGeneratedSubscriptionStatus – and the status for SIP endpoints.

Enable this flag to use the sipBulkStatusForSubscribers feature. 

  • disabled (default)
  • enabled

Additional details: 


Feature Limitations

  • On a switchover, this feature is available on the newly-active SBC. Any rollover of the dump commands started on the earlier Active SBC is not supported.

  • If the feature is enabled at runtime, the required status lists start capturing the status of the subscribers who have seen a Register/Refresh Register at least once. Additionally, the status lists will dump the complete set of registered subscribers on the system over a period of time. However, if the system experiences a restart while the feature is enabled, the complete set of registered subscribers are available in the status lists once the SBC application comes up.
  • A dumped status file remains in the system until the SBC receives the next dump request for a similar status. No history of the files are maintained in the SBC.

suppressErrorInfoHdr

N/A

Enable flag to suppress Error-Info header in a response to a request message with syntax error.

  • disabled (default) – The SBC includes Error-info header in the response.
  • enabled –  The SBC does not include Error-Info header in an error status. 
surrogateRegisterPacingTime0-10000

Use this parameter to specify the time gap, in milliseconds, between a final response of surrogate register and the next surrogate register message sent across all peers. (default = 0, disabled)

If surrogate registration is active and you wish to disable pacing, first disable surrogate registration for each peer using following command syntax:


% set addressContext <AC name> zone <zone name> ipPeer <peer name> surrogateRegistration state disabled


Note: Fully research the feature to understand pacing semantics before using it. This setting is not required in generic deployments. Pacing is applied to all surrogate REGISTER requests generated for all surrogate AoRs.

ucidNodeId

1-32767

UCID Node Id used to generate the UCID in the User-to-User Header. (default = 0)

offerAnswerTimer10 - 300 seconds

Specify the number of seconds for the SBC to wait for the Offer-Answer handshake to complete before timing out.    

Once configured, the SBC uses this value for all subsequent calls.

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

Default: 20 seconds

Note:

The offerAnswerTimer goes beyond transaction timeout value only for re-INVITE  transactions. For Media Resource Function timer (MRF) calls, if the offerAnswerTimer value has a value more than MRF timer value,  which is currently hard coded to 72 seconds , the call disconnects on MRF timer timeout, irrespective of the offerAnswerTimer timer value.

Command Example

To display the global configuration of all SIP signaling control parameters:

% show global signaling sipSigControls
    loopDetectionFeature         enabled;
    registrarSupportContactParam enabled;
    suppressErrorInfoHdr         enabled;
    maxPduSizeValue              pdusize3kb;
    egressRNParam                enabled;
    multipleContactsPerAor       enabled;
    surrogateRegisterPacingTime  enabled;
	sipBulkStatusForSubscribers  enabled;
    ucidNodeId                   13;
    offerAnswerTimer             28
     }

Single Radio Voice Call Continuity (SRVCC)

SRVCC provides the ability to transition a voice call from the VoIP/IMS packet domain (LTE) to the legacy circuit domain. Variations of SRVCC are being standardized to support both GSM/UMTS and CDMA 1x circuit domains. For an operator with a legacy cellular network who wishes to deploy IMS/VoIP-based voice services in conjunction with the rollout of an LTE network, SRVCC offers VoIP subscribers with coverage over a much larger area than would typically be available during the roll-out of a new network.

Command Syntax

% set global signaling srvcc
    atcfUri (1-63 chars)
    callLingerTimer (1-32 seconds)
    eStnSr (1-32 chars)
	pstopsSti (0-32 chars)
    stnSr (1-32 chars)


Command Parameters

Global SRVCC Parameters

Parameter

Length/Range

Description

atcfUri1-63 charactersThe SIP URI to be used as the ATCF Path and Management URI.
callLingerTimer1-32 secondsNumber of seconds to wait for INVITE due to STN_SR before clearing the call (default=32).
eStnSr0-32 characters

The Request URI for a emergency transfer call sent by MSC on PS to CS call hand-off.

Acceptable characters: alphabetical (upper- and lower-case), numerical (0-9) and any of the following special characters: +,-,.,(,)

pstopsSti

0-32 characters

The Request URI for a Packet-Switched-to-Packet-Switched (PS-to-PS) optimized hand-over call.

Acceptable characters: alphabetical (upper- and lower-case), numerical (0-9) and any of the following special characters: +,-,.,(,)

stnSr

0-32 characters

The Request URI for a transfer call sent by MSC on PS to CS call hand-off.

Acceptable characters: alphabetical (upper- and lower-case), numerical (0-9) and any of the following special characters: +,-,.,(,)

Command Example

set global signaling srvcc pstopsSti +1-pstopsSti-222
commit

show global signaling srvcc pstopsSti
pstopsSti +1-pstopsSti-222;

SIP Local Registrar

The SBC Core is enhanced to support SIP Registrar functionality for SIP end points. This feature allows the Ribbon SBC to act as an Access SBC with Registrar functionality in a single deployment. For more information regarding this feature, refer to, SIP Registrar Functionality.

Use the sipLocalRegistrar object to configure the SIP Local Registrar.


IMPORTANT

When performing bulk provisioning, Ribbon recommends using the SBC EMA or RESTCONF API, instead of the CLI.

When performing bulk provisioning from the CLI, you must issue a 'commit' after entering up to 10 commands at a time. Otherwise, it impacts the stability of the SBC and results in system health check failures. For example, when performing a bulk deletion of profiles, delete 10 profiles and then issue a commit. Repeat this rule after each 10 deletions until you complete the bulk provisioning.

Command Syntax

SIP Local Registrar
% set global signaling sipLocalRegistrar
    expires <15-65535>
    minExpires<15-65535>
    sipRegSubscriberProfile <aor Name>
        sipRegAdminState <active | inactive>
        sipRegSendChallenge <challengeForNone | challengeForRegister | challengeForRegisterAndInvite>
        sipRegAuthRealm <authentication Realm>
        sipRegAuthUserName <authentication UserName>
        sipRegAuthPassword <authentication Password>

% show global signaling sipLocalRegistrar
    sipRegSubscriberProfile <aor Name>
    expires
    minExpires

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O
expires

15-65535

3600

The Expiry value used for Registration.

O
minExpires15-6553530

The Min-Expiry value used for Registration.

If REGISTER is received with Expires value less than this field, 423 Error is generated

O
sipRegSubscriberProfile1-127 charactersN/AThis represents the Address Of Record (AOR) of the user, and is the mandatory key against which the binding is created. The AOR uses the "user@host" format. For example, testUser@example.com. Also see CLI example below.M
sipRegAdminStateN/Aactive 

Defines if Subscriber state is active or inactive. The choices are:

  • active (default)
  • inactive
O
sipRegSendChallengeN/AchallengeForNone

Defines how the Authentication Challenge is sent.

  • challengeForNone - Authentication challenge is not initiated for any of the messages.
  • challengeForRegister - Authentication challenge is initiated for REGISTER messages only.
  • challengeForRegisterAndInvite - Authentication challenge is initiated for REGISTER/INVITE messages (re-INVITE would not be challenged).
O
sipRegAuthRealm   1-127 charactersN/ATh Authorization realm for SIP registration.O
sipRegAuthUserName1-127 charactersN/AThe Authorization user name for SIP registration.O
sipRegAuthPassword   6-32 charactersN/A

DES3 (triple Digital Encryption Standard) encrypted string authentication password for SIP local registration. All ASCII characters from 33 to 126 (except 34 - double quotes) are allowed. If the Authentication Password contains ASCII characters, enclose the entire password string within double quotes (" ") .

For example: "Password1:@\#:########~%&*@#"

Since the SBC Registrar supports bulk load configuration, the length of the password string is not validated at the time of entry into the database. The Administrator must make sure that length is within the prescribed range (6-32 characters). For out of bound passwords, authentication will fail with a 403 error response.

O

Command Example

sipLocalRegistrar Configuration Examples
set global signaling sipLocalRegistrar expires 3500
set global signaling sipLocalRegistrar minExpires 300

set global signaling sipLocalRegistrar sipRegSubscriberProfile testUser@example.com sipRegAdminState active sipRegSendChallenge challengeForRegisterAndInvite sipRegAuthRealm example.com sipRegAuthUserName testUser sipRegAuthPassword password1

show global signaling sipLocalRegistrar sipRegSubscriberProfile testUser@example.com
      sipRegAuthUserName  testUser;
      sipRegAuthRealm     example.com;
      sipRegAuthPassword  $7$FZ5ju2oDUvNyLs8MvuBYmoCo55fOBhnu;
      sipRegAdminState    active;
      sipRegSendChallenge challengeForRegisterAndInvite;

show global signaling sipLocalRegistrar expires
expires 3500

show global signaling sipLocalRegistrar minExpires
minExpires 300

show status global sipLocalRegistrar
sipLocalRegistrarRegStatus 53056@10.xx.xx.70 {
    state          active;
    contactURI     sip:53056@10.xx.1xx.xx:5xx0;
    expirationTime 3600;
    creationTime   2022-09-08T10:23:29+00:00;
    remainingTime  3493;
}
sipLocalRegistrarRegCountStatistics entry {
    sipRegAttemptCount      1;
    sipRegChallengedCount   1;
    sipRegStableCount       1;
    sipRegFailed403Count    0;
    sipRegFailed404Count    0;
    sipRegFailed503Count    0;
    sipRegFailedOthersCount 0;
}

request global sipLocalRegistrar sipRegCountReset

request global sipLocalRegistrar sipRegistrationDeleteByAor sipRegAor 53056@10.xx.xx.70
result success

Teams Support

The SBC supports special behavior of SIP Signaling, when interfacing with Microsoft Teams.

Command Syntax

% set global signaling teamsSupport <disabled | enabled>

Command Parameters

Teams Support

ParameterDescription
teamsSupport

Enable this flag to configure SIP Signaling for interfacing with MS Teams.

Note: When you enable this global control, the SBC sends out both SDES and DTLS in the offer, if both are enabled in the Packet Service Profile. This might only be required if there is a Microsoft Teams client running in a browser.

  • disabled (default)
  • enabled

Command Example

  • To configure sipIpPeerStats, use the following example:

    % set global signaling teamsSupport enabled
% commit
  • To display the teamsSupport, use the following example:

    • In the "configure" mode:

      % show global signaling teamsSupport
teamsSupport enabled;

    • In the "display" mode (when you exit the "configure" mode):

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

SIP Adaptor Profile

The SIP Adaptor Profile object is the main construct for SIP Message Manipulation (SMM) functionality. Using SMM criteria and actions, you define SMM rules within a SIP Adaptor Profile. The SBC applies the profile to SIP messages in order to modify their headers and/or parameters. When a message comes into or out of the SBC and a SIP Adaptor Profile applies, the message is evaluated based on the set of criteria in the profile. If the message meets the criteria, it is modified according to actions defined in the profile. You can assign SMM profiles at the global, address context, zone, and SIP trunk group levels. You have the option to define profiles at any or all of these levels.

Command Syntax

% set profiles signaling sipAdaptorProfile <Profile Name> rule <#> action <#> from type flexVariable
% set profiles signaling sipAdaptorProfile <Profile Name> rule <#> action <#> from flexVariableValue <flexvar1...flexvar16>

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O

flexVariable

flexvar1 to flexvar16

N/A

The flex variable name of the SIP PDU manipulation entry. Use this parameter to store up to 16 flex variables received from the PSX as input to the SBC SMM to modify SIP messages on the Egress leg.

M

Configuration Examples

set profiles signaling sipAdaptorProfile smm1 rule 1 action 1 from type flexVariable
set profiles signaling sipAdaptorProfile smm1 rule 1 action 1 from flexVariableValue flexVar1
commit


SMM Configuration Examples

Example SMM for REGISTER request, where the username is modified in the Egress register:

set profiles signaling sipAdaptorProfile EBOSMM state enabled
set profiles signaling sipAdaptorProfile EBOSMM advancedSMM enabled
set profiles signaling sipAdaptorProfile EBOSMM profileType messageManipulation
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 1 message
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 1 message messageTypes request
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 1 message methodTypes [ register ]
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 2 header
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 2 header name to
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 3 type token
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 3 token
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 3 token condition exist
set profiles signaling sipAdaptorProfile EBOSMM rule 1 criterion 3 token tokenType uriusername

set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 type token
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 operation modify
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 from
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 from type flexVariable
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 from flexVariableValue flexVar1
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 to
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 to type token
set profiles signaling sipAdaptorProfile EBOSMM rule 1 action 1 to tokenValue uriusername
commit

This example shows the PSX-received LOGO parameter is added as a Call-info header in the Egress INVITE:

set profiles signaling sipAdaptorProfile AddCallinfo state enabled
set profiles signaling sipAdaptorProfile AddCallinfo advancedSMM enabled

set profiles signaling sipAdaptorProfile AddCallinfo rule 1 applyMatchHeader one
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 1 message
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 1 message messageTypes request
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 1 message methodTypes [ invite ]
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 2 type messageBody
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 2 messageBody
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 2 messageBody condition exist
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 3 type flexVariable
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 3 flexVariable
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 3 flexVariable condition exist
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 criterion 3 flexVariable variableID flexVar4

set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 type header
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 operation add
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 headerPosition last
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 from
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 from type flexVariable
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 from flexVariableValue flexVar4
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 to
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 to type header
set profiles signaling sipAdaptorProfile AddCallinfo rule 1 action 1 to value Call-Info
commit

Example of a flex variable stored in a dialog scope variable, and used in a re-INVITE:

set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 type variable
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 operation store
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 from
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 from type flexVariable
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 from flexVariableValue flexVar1
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 to
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 to type variable
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 to variableValue var1
set profiles signaling sipAdaptorProfile AddCallinfo rule 2 action 2 to variableScopeValue dialog
commit

Old GSX Support

The SBC is enhanced with a configurable parameter to indicate a legacy meshed network exists on the GW-GW links. This ensures the size of a message to send to older GSXs or remote pre-9.1 SBCs does not exceed the supported size of the remote GW.

Any SBC - running 9.1 or higher version - passes information about the maximum size GW message it can support in the initial GW link setup handshake. The SBC sending the GW message will now release the call with a 500 error response, if the size of the message to be sent is larger than can be supported by the remote GW.

This parameter is used so the SBC reduces the maximum size of the PDUs that can be sent over a GW-GW connection to GSXs to prevent sending a PDU larger than the buffer size allocated on the GSX, which can cause memory corruption. 

Command Syntax

% set global signaling oldGsxSupport <disabled | enabled>


Command Parameter

ParameterDescription
oldGsxSupport

When the flag is enabled, the SBC reduces the maximum size of the PDUs sent over a GW-GW connection to a GSX to prevent the PDU sizes from becoming larger than the buffer size allocated on the GSX, which can cause crashes on the GSX. When changing this control, the GW-GW links need to be restarted in order for it to take effect. This functionality also applies to a remote pre-9.1 SBC.

  • disabled
  • enabled (enabled)

Command Example

set global signaling oldGsxSupport enabled