DO NOT SHARE THESE DOCS WITH CUSTOMERS!
This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.
In this section:
These sections describe configuration objects used to configure signaling at the global level. The following diagram depicts a basic signaling configuration.
Use the crankBackProfile
parameter to assign a crankback profile at the global level. The CLI syntax is shown below.
% 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.
Use this object to configure global diameter signaling controls.
% set global signaling diamSigControls addSonusSpecificAVP <disabled | enabled> defaultCCF <ipAddress> enableRfApp <disabled | enabled> generateFailedEventAcr <disabled | enabled> maxACRretransmission <0-3> rfInterimAccInrvl <0-180>
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.
Note: Refer to Rf Interface Support for AVP details. |
defaultCCF | Up 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). |
enableRfApp | N/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.
|
generateFailedEventAcr | N/A | Enable the flag to send an ACR for the failed event.
|
maxACRretransmission | 0-3 | <#> – Set the maximum number of ACR retransmissions to use if the Unable to show "metadata-from": No such page "_space_variables" does not receive ACA (default = 3). |
rfInterimAccInrvl | 0-180 |
Note: If ACA has a different value than |
sigOnlyModeValue | N/A | This global option controls whether the SBC is in signaling-only mode.
Note: You can only switch the Unable to show "metadata-from": No such page "_space_variables" into or out of signaling-only mode when no active calls are present in the system. |
This object allows you to configure the signaling timers for the gateway.
% 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
Global Gateway Signaling Timers Parameters
Parameter | Description |
---|---|
| Delay time (in seconds) before a release is issued for calls rejected due to congestion. (default=0) |
| The Gateway Signal Channel Establishment Timer (in seconds.) This value applies to all signal channels. (default = 10). |
| Idle time (in hours) for a GW Signaling Link May before it is taken down. (default = 0). |
| The Gateway Signal Channel Keep-alive Timer (in seconds.) This value applies to all signal channels. (default = 3). |
| 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). |
This object allows you to configure signaling timers for the node.
% 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
Global H.323 Signaling Timers Parameters
Parameter | Length/Range | Description | Default |
---|---|---|---|
| 0-127 | The H225 signal channel establishment timer (in seconds). Default value is 4. | 4 |
| 0-65535 | The T301 call timer (in seconds). | 180 seconds |
| 0-127 | The T302 call timer (in seconds). | 15 seconds |
| 0-127 | The T303 call timer (in seconds). | 4 seconds |
| 0-127 | The T304 call timer (in seconds). | 20 seconds |
| 0-127 | The T310 call timer (in seconds). | 10 seconds |
| 0-127 | The TCP connect timer (in seconds). | 3 seconds |
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;
Configure the SBC for the maximum number of transfers (10-100
) allowed within a call; default is 10
.
% set global signaling maxNumTransfers <10-100>
Max Num Transfers
Parameter | Description |
---|---|
maxNumTransfers | Specifies the maximum number of transfers (10-100 ) allowed within a call; default is 10 . |
To configure maxNumTransfers
, use the following example:
% set global signaling maxNumTransfers 30 % commit
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; }
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.
% set global signaling messageManipulation inputAdapterProfile <profile name> outputAdapterProfile <profile name>
SIP Message Manipulation
Parameter | Description |
---|---|
|
|
| <profile name> – Enter the name of a SIP adaptor profile to use globally on outbound messages. |
% set global signaling messageManipulation inputAdapterProfile globalInput % set global signaling messageManipulation outputAdapterProfile globalOutput % commit
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.
% set global signaling sigOnlyMode sigOnlyModeValue <global | off>
Signaling Only Mode Parameter
Parameter | Description |
---|---|
| This global option controls whether the SBC is in signaling-only mode. The options are:
|
% set global signaling sigOnlyMode sigOnlyModeValue global commit
Use this flag to configure support for SIP IP Peer Statistics in the SBC.
% set global signaling sipIpPeerStats <disabled | enabled>
SIP IP Peer Status
Parameter | Description |
---|---|
sipIpPeerStats | Enable this flag to configure support for SIP IP Peer Statistics in the SBC.
|
To configure sipIpPeerStats
, use the following example:
% set global signaling sipIpPeerStats enabled % commit
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; }
This object allows you to configure SIP Peer Overload parameters.
% 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
Global SIP Peer Overload Control Parameters
Parameter | Length/Range | Description |
---|---|---|
| 1-10 | Discard period (in seconds) for the Peer Overload back-off algorithm. (default = 2). |
| 0-50 | Specifies the reject threshold (in rejects/sec) for the Peer Overload backoff algorithm. (default = 1). |
| 1-10 | Specifies the sampling period (in seconds) for the Peer Overload back-off algorithm. (default = 2). |
| 1-200 | Specifies the step-down gain for the Peer Overload back-off algorithm. (default = 100). |
| 1-64 | To display different levels of output information in show commands. |
To display the global configuration of all SIP overload control:
% show global signaling sipPeerOverloadControl samplingPeriod 2; discardPeriod 1; stepDownGain 44; rejectThreshold 33;
Use this object to configure SIP signaling control parameters.
% set global signaling sipSigControls egressRemoveEnudmi <disabled | enabled> egressRNParam <disabled | enabled> loopDetectionFeature <disabled | enabled> maxPduSizeValue <pdusize2kb | pdusize3kb | pdusize6kb | pdusize15kb | pdusize32kb | pdusize60kb> multipleContactsPerAor <disabled | enabled> registrarSupportContactParam <disabled | enabled> send503DuringSwitchover <disabled | enabled> sendDeRegisterContactAsStar <disabled | enabled> sendSurrogateUnRegAfterReboot <disabled | enabled> suppressErrorInfoHdr <disabled | enabled> surrogateRegisterPacingTime <0-10000> ucidNodeId <node_id> offerAnswerTimer <10-300> % show global signaling sipSigControls % delete global signaling sipSigControls
Global SIP Signaling Control Parameters
Parameter | Length/Range | Description |
---|---|---|
| NA | Controls whether the SBC removes the
|
| 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.
|
| N/A | When enabled, the SIP Stack performs loop detection on incoming INVITE messages.
|
| N/A | The maximum PDU size recognized by the Unable to show "metadata-from": No such page "_space_variables" :
|
| N/A | Use this flag to support multiple contacts per Address Of Record (AoR).
The SBC supports validating the source IP address and the port even if 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 Note: Refer to Multiple Contacts per AoR feature page for additional details. Note: Even though the default value of |
| N/A | Enable flag to support parameters in the Contact header:
|
send503DuringSwitchover | N/A | Use this flag to control the sending of 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 Unable to show "metadata-from": No such page "_space_variables" to send the Contact header as a star (*) in DEREGISTER messages if multipleContactsPerAor is disabled.
|
sendSurrogateUnRegAfterReboot | N/A | Enable flag to trigger de-register messages to all AORs configured to use the Surrogate Registration feature after a reboot.
|
| N/A | Enable flag to suppress Error-Info header in a response to a request message with syntax error.
|
surrogateRegisterPacingTime | 0-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:
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. |
| 1-32767 | UCID Node Id used to generate the UCID in the User-to-User Header. (default = 0) |
offerAnswerTimer | 10 - 300 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 Default: 20 seconds Note: The |
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; ucidNodeId 13; offerAnswerTimer 28 }
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.
% set global signaling srvcc atcfUri (1-63 chars) callLingerTimer (1-32 seconds) eStnSr (1-32 chars) pstopsSti (0-32 chars) stnSr (1-32 chars)
Global SRVCC Parameters
Parameter | Length/Range | Description |
---|---|---|
atcfUri | 1-63 characters | The SIP URI to be used as the ATCF Path and Management URI. |
callLingerTimer | 1-32 seconds | Number of seconds to wait for INVITE due to STN_SR before clearing the call (default=32). |
eStnSr | 0-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: +,-,.,(,) |
| 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: +,-,.,(,) |
| 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: +,-,.,(,) |
set global signaling srvcc pstopsSti +1-pstopsSti-222 commit show global signaling srvcc pstopsSti pstopsSti +1-pstopsSti-222;
The SBC supports special behavior of SIP Signaling, when interfacing with Microsoft Teams.
% set global signaling teamsSupport <disabled | enabled>
Teams Support
Parameter | Description |
---|---|
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.
|
To configure sipIpPeerStats
, use the following example:
% set global signaling teamsSupport enabled % commit
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; }
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.
% set profiles signaling sipAdaptorProfile <Profile Name> rule <#> action <#> from type flexVariable % set profiles signaling sipAdaptorProfile <Profile Name> rule <#> action <#> from flexVariableValue <flexvar1...flexvar16>
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
| 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 |
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
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