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.

 

This section lists SIP Common IP Attributes transparency flags details.


Note

The SBC supports globalizing the Request-URI by enabling globalization for the called number and enabling the To-Header Transparency flag. Thus, the Request-URI called number is not transmitted transparently to the egress leg (To-Header transparency flag will not affect Request-URI globalization). Note that Request-URI globalization is independent of the To-Header Transparency. This functionality applies to all scenarios where To-Header transparency is enabled, such as:

  • Redirection scenarios
  • Refer scenario
  • Interaction with Undo LNP
  • Modifying hostname of reqURI

Command Syntax

% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes transparencyFlags 
	acceptContactHeader <disable | enable> 
	acceptHeader <disable | enable> 
	acceptLanguageHeader <disable | enable>
	alertInformationHeader <disable | enable> 
	authcodeHeaders <disable | enable> 
	callInfoHeader <disable | enable> 
	contactHeader <disable | enable> 
	errorInfo <disable | enable> 
	externalBody <disable | enable>
	fromHeader <disable | enable> 
	geolocation <disable | enable> 
	geolocationError <disable | enable> 
	geolocationRouting <disable | enable> 
	historyInfo <disable | enable> 
	maxForwardsHeader <disable | enable> 
	messageExternalBody <disable | enable>
	mwiBody <disable | enable> 
	pAccessNetworkInfoHeader <disable | enable> 
	pCalledPartyID <disable | enable> 
	pChargingVectorHeader <disable | enable> 
	pEarlyMedia <disable | enable> 
	pVisitedNetworkIDHeader <disable | enable> 
	passCompleteContactHeader <disable | enable> 
	pathHeader <disable | enable> 
	pidfBody <disable | enable>
	pidfDiffBody <disable | enable>
	qsigBody <disable | enable> 
	reasonHeader <disable | enable> 
	referredByHeader <disable | enable> 
	requestURI <disable | enable> 
	resourceListBody <disable | enable>
	resourcePriorityOptionTag <disable | enable>
	rlmiBody <disable | enable>
	routeHeader <disable | enable> 
	serverHeader <disable | enable>
	serviceRouteHeader <disable | enable> 
	simpleFilterBody <disable | enable>
	sipBody <disable | enable> 
	sipfragBody <disable | enable> 
	toHeader <disable | enable> 
	toneBody <disable | enable> 
	unknownBody <disable | enable> 
	unknownHeader <disable | enable> 
	userAgentHeader <disable | enable>
	userToUserHeader <disable | enable> 
	viaHeader <disable | enable>
	warningHeader <disable | enable>
	watcherInfoBody <disable | enable>

 

Command Parameters

For a list of SIP headers that cannot be controlled using transparency flags in relay scenarios, refer to IPSP Transparency Flags.

 


IMPORTANT

Ribbon recommends using the Transparency Profile to configure transparency on the SBC Core for new deployments, as well as applying additional transparency configurations to existing deployments. Do not use IP Signaling Profile flags in these scenarios because the flags will be retired in upcoming releases.

Refer to the SBC SIP Transparency Implementation Guide for additional information.

 

Transparency Flags

Parameter

Description

acceptContactHeaderSet flag to allow P-CSCF to transparently pass the received Accept-Contact Header.
  • disable (default)
  • enable
acceptHeaderUse this flag to determine Accept header behavior.
  • disable (default) – Accept header includes: application/sdp, application/isup, application/dtmf, application/dtmf-relay, multipart/mixed information.
  • enable – Accept header is transparently passed from ingress to egress.
acceptLanguageHeaderEnable to allow Accept-Language Header transparency.
  • disable (default)
  • enable
alertInformationHeaderSet this flag to transparently copy the ALERT INFO header from the ingress SIP INVITE method to the egress SIP INVITE message.
  • disable (default)
  • enable
authcodeHeadersEnable this flag to transparently copy the WWW Authentication header for SIP 401/407 response messages or SIP Authorization/Proxy Authorization headers.
  • disable (default)
  • enable

NOTE: You must enable statusCode4xx6xx relay flag when using authcodeHeaders transparency.

 callInfoHeader  Set flag to transparently pass Call-Info header, if present, in the incoming message.
  • disable (default)
  • enable
contactHeaderSet flag to transparently pass the Contact Header Flag in egress leg with respect to the message direction.
  • disable (default)
  • enable
errorInfoEnable this flag to transparently copy the Error-Info header from the ingress leg to the egress leg.
  • disable (default)
  • enable
externalBodyEnable to send message/external-body transparently.
  • disable (default)
  • enable
fromHeaderEnable this flag to transparently copy the userinfo@host component of the FROM header from the ingress SIP INVITE message to the egress SIP INVITE message.
  • disable (default)

  • enable

NOTE: Even when this flag is enabled, the IP port information is not included unless the "Include IP Ports in From and To Headers" flag, elsewhere in this IP Signaling Profile, is also enabled

geolocationSet flag to transparently pass Geolocation header, if present, in incoming message.
  • disable (default)
  • enable
geolocationError Set flag to transparently pass Geolocation-Error header, if present, in incoming message.
  • disable (default)
  • enable
geolocationRouting Set flag to transparently pass Geolocation-Routing header, if present, in incoming message.
  • disable (default)
  • enable
historyInfoControls History-info header transparency in SIP INVITE messages. When enabled, the SBCpasses the History-Info header transparently from the ingress message to the egress message. When disabled, the SBC does not copy the history-info. Provision this flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
maxForwardsHeaderEnable this flag to decrement the value in Max-Forwards header by 1 for requests traversing through the SBC. By default (disable), the SBC populates the Max-Forwards header with the value configured in maxFwdsDefault (default value is 70).
  • disable (default)
  • enable
messageExternalBodyEnable flag to pass Message External Body transparently.
 
  • disable (default)
  • enable
mwiBody Enable flag to transparently copy the MWI body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision this flag on the egress leg with respect to message direction.
  • disable (default)
  • enable
pAccessNetworkInfoHeaderEnable flag to transparently pass the p-Access-Network-Info (PANI) header from ingress to egress.
  • disable (default) – SBC suppresses the PANI header towards egress messages when the incoming message contains PANI header.

  • enable – SBC transparently passes PANI header from ingress to egress.

NOTE: Enable this flag when SBC is configured as P-CSCF node.

pCalledPartyID

Set flag to transparently pass the P-Called-Party-ID header from ingress to egress call leg.
  • disable (default)
  • enable
pChargingVectorHeaderWhen enabled, the SBC transparently copies the P-Charging-Vector header from the ingress message to the egress message. When disabled, the SBCdoes not copy the header. PCharging- Vector header transparency is supported in INVITE, REGISTER, SUBSCRIBE, OPTIONS, MESSAGE, PUBLISH, NOTIFY, REFER, and INFO messages.
  • disable (default)
  • enable
pEarlyMediaControls P-Early Media header transparency in INVITE or non-100 RESPONSE requests and their responses if they are relayed. When enabled, the SBC transparently copies the P-Early Media header from the incoming message to the outgoing message. When disabled, the PEarly- Media header is not copied to the egress leg. Provision this flag on egress leg with respect to message direction.
  • disable (default)
  • enable
pidfBodyEnable to send application/pidf+xml body transparently.
  • disable (default)
  • enable
pidfDiffBodyEnable to send application/pidf-diff+xml body transparently.
  • disable (default)
  • enable
pVisitedNetworkIDHeaderEnable flag to pass the P-Visited-Network-ID header transparently to the egress leg.
  • disable (default)
  • enable
passCompleteContactHeaderEnable flag at egress IPSP (with respect to message direction) to copy the Contact header and its parameters from the ingress message and insert in the egress message.
  • disable (default)
  • enable
pathHeaderEnable flag to transparently copy the Path header from the ingress SIP message to the egress SIP message.
  • disable (default)
  • enable
qsigBodyEnable flag to transparently copy the QSIG body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision this flag on the egress leg with respect to message direction.
  • disable (default)
  • enable
reasonHeaderWhen enabled, the ingress Reason header value is passed through unchanged.
  • disable (default)
  • enable
referredByHeaderWhen enabled, SBCtransparently copies the Referred-By Header (in INVITE requests/responses) from the incoming message to the outgoing message. When cleared, the Referred-By Header is not copied. Provision this flag on the egress leg (with respect to the message direction).
  • disable (default)
  • enable
requestURIEnable flag to transparently copy the Request URI from the incoming message to the outgoing message for INVITE, REGISTER, SUBSCRIBE/NOTIFY. Provision this flag on the egress leg (with respect to the message direction).
  • disable (default)
  • enable
resourceListBodyEnable to send application/resource-lists+xml body transparently.
 
  • disable (default)
  • enable
resourcePriorityOptionTagEnable to transparently pass 'resource-priority' option tag received in Require or Supported header of SIP messages.
  • disable (default)
  • enable
rlmiBodyEnable to send application/rlmi+xml transparently.
  • disable (default)
  • enable
routeHeaderEnable flag to transparently copy the Route header from the ingress SIP message to the egress SIP message.
  • disable (default)
  • enable
serverHeaderEnable to allow Server Header transparency.
  • disable (default)
  • enable
serviceRouteHeaderEnable flag to transparently copy the Service-Route header from the ingress SIP message to the egress SIP message.
  • disable (default)
  • enable
simpleFilterBodyEnable to send application/simple-filter+xml content-type transparently.
  • disable (default)
  • enable
sipBodyEnable flag to transparently copy the SIP body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE, if relayed. Provision this flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
sipfragBodyEnable flag to transparently copy the SIPFRAG body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
toHeader

Enable flag to transparently copy the userinfo@host component of the TO header from the ingress SIP INVITE message to the egress SIP INVITE message. When flag is disabled, SBC generates its own TO header.

  • disable (default)
  • enable

NOTE: Even when this flag is enabled, the IP port information is not included unless the "Include IP Ports in From and To Headers" flag, elsewhere in this IP Signaling Profile, is also enabled.

toneBodyEnable flag to transparently copy the Tone body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
unknownBodyEnable flag to transparently copy the Unknown body from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
unknownHeaderEnable flag to transparently copy the Unknown header from the incoming message to the outgoing message for INVITE, REGISTER, BYE, INFO, OPTIONS, NOTIFY, REFER, and SUBSCRIBE. Provision flag on the egress leg with respect to the message direction.
  • disable (default)
  • enable
userAgentHeaderEnable to allow User-Agent header transparency.
  • disable (default)
  • enable
userToUserHeaderWhen the ingress INVITE contains the User-to-User header and this transparency flag is enabled, the User-to-User header passes through to the egress.
  • disable (default)
  • enable
viaHeaderUse this flag to specify the behavior of VIA header, the source address of the call originator.
  • disable – (default) Default behavior where IP address on the VIA header is the local SIP signaling address.
  • enable – Transparently pass all the VIA headers received in original INVITE or REGISTER. With only the transparency flag enabled,  the SBC will still include the local SIP signaling address and port as the top most VIA header.
warningHeader Enable to allow Warning Header transparency.
  • disable (default)
  • enable
watcherInfoBody Enable to send application/watcherinfo+xml transparently.
  • disable (default)
  • enable

 

Command Example

From system-level prompt, use following command to view IP signaling profile flags for DEFAULT_SIP profile in table format.

 > show table profiles signaling ipSignalingProfile DEFAULT_SIP egressIpAttributes flags 
bgcfTargetSchemeTransparency disable; 
convertInactiveToSendrecv disable; 
disable2806Compliance disable; 
disableOptionalRegisterParameters disable; 
map181Or182MessageTo183 disable; 
mapContractorNumberInPSigInfoHeader disable; 
suppressUnregister disable; 
ttcIsupMapping disable; 
useCalledPartyInRequestUri disable; 
useColonInSdpMediaTypeParameter disable; 
validateIsubAddress disable; 
qosBasedRouting disable;

 

Call Flow Examples

Call Flow Examples for 'Disable Media Lockdown' Flag

Example1:

In the following call flow, the Modify Offers (in green) are suppressed if the Minimize Relaying Of Media Changes From Other Call Leg flag is enabled:

Ingress Peer

 

SBC

 

Egress Peer

G711U

->

SBC offers G711U as pass-through codec and G729A as a transcode option by reserving a DSP channel

->

G711U,G729A

G711U

<-

SBC releases the DSP channel resulting in a G711U pass-thru call

<-

G711U



Receive capabilities of SBC have changed as a codec G729A was removed and the DSP channel de-allocated.
Default behavior is to send Modify Offer; to suppress, the Minimize Relaying Of Media Changes From Other Call Leg flag should be enabled

->

G711U




<-

G711U

Example 2:

The messages (in green) can be suppressed if the Disable Media Lock Down field is enabled.

Ingress Peer

 

SBC

 

Egress Peer

G711U

->

SBC offers G711U as pass-through codec and G729A as a transcode option by reserving a DSP channel

->

G711U,G729A

G711U

<-

SBC releases the DSP channel resulting in a G711U pass-thru call

<-

G711U,G729A



Receive capabilities of SBC have changed as a codec G729A was removed and the DSP channel de-allocated.
Default behavior is to send Modify Offer; the Minimize Relaying Of Media Changes From Other Call Leg flag cannot suppress this Modify Offer as a common codec in the original offer and answer (G729A) has been removed; To suppress this re-INVITE, enable DML

->

G711U




<-

G711U

Ingress Peer

 

SBC

 

Egress Peer

G711U

->

SBC offers G711U as pass-through codec and G729A,G726 as transcode options by reserving a DSP channel

->

G711U,G729A,G726

G711U

<-

Transcode G711-G729A call. Egress codec is locked down to G729A

<-

G729A,G726



Receive capabilities of SBC have changed to G729A due to transcode.
Default behavior is to send Modify Offer to lockdown to G729A; the Minimize Relaying Of Media Changes From Other Call Leg flag cannot suppress this Modify Offer as a common codec in the original offer and answer (G726) has been removed; To suppress this re-INVITE, enable DML

->

G729A




<-

G729A

Example 3:

Scenario in which Disable Media Lockdown field can not suppress the media lock down messages (in green).

The codecs configured at Egress route PSP are G711U, G726, G729A with HRP disabled.

Ingress Peer

 

SBC

 

Egress Peer

G711U

->

SBC offers G711U as pass-through codec and G726,G729A as transcode options by reserving a DSP channel

->

G711U,G726,G729A

G711U

<-

Transcode G711-G726 call. Egress codec is locked down to G726

<-

G729A,G726



Receive capabilities of SBC have changed to G726 ( i.e. HRP is disabled). Since, the codec selected by SBC is different from Peer’s preferred codec (G729), though the flag DML is enabled SBC sends a Modify Offer to lockdown to G726.

->

G726




<-

G726

Call Flow Examples for 'Minimize relaying of Media Changes From Other Call Leg All' Flag

Example1:

The re-INVITEs (in green) are suppressed if the Minimize Relaying Of Media Changes From Other Call Leg flag is enabled.

Ingress Peer

 

SBC

 

Egress Peer

G711U

->

SBC offers G711U as pass-through codec and G729A as a transcode option by reserving a DSP channel

->

G711U,G729A

G711U

<-

SBC releases the DSP channel resulting in a G711U pass-thru call

<-

G711U



Receive capabilities of SBC have changed as a codec G729A was removed; send Modify Offer to Peer to advertise the latest set of capabilities

->

G711U




<-

G711U

Example2:

SBC suppresses a Modify Offer from the ingress peer. The offer changes the maxptime from 10 to 20ms. An increase in maxptime can be suppressed – a device that advertises a maxptime of 20ms can also receive 10ms packets.

Ingress Peer

 

SBC

 

Egress Peer

G711U 10ms

->


->

G711U 10ms

G711U

<-


<-

G711U

Re-INVITE (G711U 20ms)

->

Suppress the re-INVITE if minimize media is enabled and respond to ingress peer; else forward the re-INVITE to egress

->

G711U 20ms

G711U

<-


<-

G711U

Conversely, irrespective of the state of the Minimize Relaying Of Media Changes From Other Call Leg flag All field cannot suppress a change of maxptime from 20ms to 10ms.

Ingress Peer

 

SBC

 

Egress Peer

G711U 20ms

->


->

G711U 20ms

G711U

<-


<-

G711U

Re-INVITE (G711U 10ms)

->


->

G711U,10ms

G711U

<-


<-

G711U

Example3:

A change of data-path-mode from sendrecv to sendonly ( HOLD request) can also be suppressable. The rational is that SBC can always ignore the media received from the peer and continue to send it media.

Ingress Peer

 

SBC

 

Egress Peer

G711U sendrecv

->


<-

G711U sendrecv

G711U

<-


->

G711U

Re-INVITE (G711U sendonly)

->

Suppress the re-INVITE if minimize media is enabled and respond to ingress peer; else forward the re-INVITE to egress

<-

G711U sendonly

G711U

<-


->

G711U

Conversely, SBC irrespective of the state of the Minimize Relaying Of Media Changes From Other Call Leg flag, cannot suppress a change of data-path-mode from sendonly to sendrecv.

Ingress Peer

 

SBC

 

Egress Peer

G711U sendonly

->


->

G711U sendonly

G711U

<-


<-

G711U

Re-INVITE (G711U sendrecv)

->


->

G711U sendrecv

G711U

<-


<-

G711U

Call Flow Examples for 'Relay Data Path Mode Change From Other Call Leg' Flag

Example1:

When Minimize Relaying Of Media Changes From Other Call Leg flag is enabled, and when Relay Data Path Mode Change From Other Call Leg is disabled:

Ingress Peer

 

SBC

 

Egress Peer

G711U,G729A sendrecv

->


->

G711U,G729A sendrecv

G711U

<-


<-

G711U

Re-INVITE (G711U sendonly)

->

Suppress the re-INVITE and respond to ingress peer. Discard media received from the egress peer



G711U

<-




Example2:

When the Minimize Relaying Of Media Changes From Other Call Leg flag is enabled, and when Relay Data Path Mode Change From Other Call Leg is enabled:

Ingress Peer

 

SBC

 

Egress Peer

G711U,G729A sendrecv

->


->

G711U,G729A sendrecv

G711U

<-


<-

G711U

Re-INVITE (G711U sendonly)

->


->

G711U sendonly

G711U

<-


<-

G711U

  • No labels