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:


This section lists SIP Common IP Attributes Relay Flags parameter details.

Note

The methods relay flags control the relay of in-dialog non-INVITE and non-REGISTER methods within dialogs established by the SIP INVITE method.

Command Syntax

% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes relayFlags
	conferenceEventPackage <disable | enable>
	dialogEventPackage <disable | enable> 
	dtmfBody <disable | enable> 
	force503to500Relay <disable | enable> 
	info <disable | enable> message <disable | enable>
	messasge <disable | enable>
	notify <disable | enable> options <disable | enable> 
	options <disable | enable>
	publish <disable | enable> refer <disable | enable> 
	refer <disable | enable>
	referToHeaderRelay <disable | enable>
	regEventPackage <disable | enable> 
	sonusMediaBody <disable | enable> 
	statusCode3xx <disable | enable> 
	statusCode4xx6xx <disable | enable> 
	thirdPartyBodies <disable | enable>
	updateWithoutSdp <disable | enable>

Command Parameters

Relay Flags

Parameter

Description

conferenceEventPackageEnable to relay conference event xml message body (application/conference-info+xml body) to the peer.
  • disable (default)
  • enable

NOTE: To pass this body transparently, enable the conference-info xml body relay flag.

dialogEventPackage  
 Enable this flag to allow the SBC to send the Dialog Event Package to the peer.
  • disable (default)
  • enable

NOTE: This flag only applies to unregistered users.

dtmfBody
Enable flag to allow the SBC to relay DTMF body to the peer for responses to INVITE and BYE messages, relayed INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request messages, and relayed 3xx, 4xx, 5xx, and 6xx in response to INVITE messages. Provision this flag on the ingress leg with respect to the message direction.
  • disable (default)
  • enable
force503to500RelayEnable flag to force 503 Service Unavailable message to map to 500 Internal Server Error message.
  • disable (default)
  • enable
info
Enable to relay SIP INFO method to the peer. If disabled, the SBC processes SIP INFO methods locally.
  • disable (default)
  • enable
message
Enable to relay SIP MESSAGE method to the peer. If disabled, the SBC processes SIP MESSAGE methods locally.
  • disable (default)
  • enable
notify
Enable this flag to relay SIP NOTIFY method to the peer. If disabled, the SBC processes SIP NOTIFY methods locally.
  • disable (default)
  • enable
options
Enable this flag to relay SIP OPTIONS method to the peer. If disabled, the SBC processes SIP OPTIONS methods locally.
  • disable (default)
  • enable

NOTE: The SBC will relay the OPTIONS method if Route header is present and Max-forwards value is not "0" irrespective of whether this flag is enabled or disabled. If no suitable route is found, the SBC returns "404 Not Found" error response.

publish
Controls the transfer of instant messages (IMs). Enable flag to allow the SBC to relay SIP PUBLISH methods to the peer. When disabled, the SBC processes SIP PUBLISH methods locally. Provision this flag on the ingress leg with respect to the message direction.
  • disable (default)
  • enable
refer
When enabled, the SBC relays SIP REFER methods to the peer. When disabled, the SBC processes SIP REFER methods locally.
  • disable (default)
  • enable

Note: Starting with SBC SWe version 8.1, the D-SBC supports REFER (without replaces) in relay and local processing mode for audio pass-through calls.

referToHeaderRelay

Use this flag to relay the replaces in refer-To header of relayed REFER request. The options are:

  • rejectReferIfnoMatchForcallId (default) – If no match is found for the call-Id received, the REFER is rejected.
  • relayReferIfNoMatchForCallId – The SBC tries to match the received call-Id. If  a match is found, the SBC translates the replaces header and relays the REFER message. If no match is found for call-id, the SBC relays the replaces without any changes.
  • relayReferWithoutMatching – The SBC always relays the replaces in refer-to without searching for match of call-id.
regEventPackage
Enable this flag to relay Registration Event Package information to the peer. If disabled, the SBC rejects the Registration Event Package.
  • disable (default)
  • enable
sonusMediaBodyEnable this flag to relay Ribbon media body to the peer for responses to INVITE and BYE messages, relayed INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request messages and relayed 3xx, 4xx, 5xx, and 6xx in response to INVITE messages. Provision this flag on the ingress leg with respect to the message direction.
  • disable (default)
  • enable
statusCode3xxEnable this flag to relay 3xx status code to the peer in response to INVITE requests. Provision this flag on the trunk group that receives the 3xx response (the egress leg of the call).
  • disable (default)
  • enable
statusCode4xx6xxEnable this flag to relay the error status codes (4xx, 5xx, or 6xx) in response to initial INVITE requests (does not apply to re-INVITEs). Provision this flag on the trunk group that receives the error response (the egress leg of the call).
  • disable (default)
  • enable

NOTE: You must enable this flag when using authcodeHeaders transparency flag.

thirdPartyBodies Enable this flag to relay third party bodies to the peer in response to INVITE and BYE messages, relayed INFO, REFER, MESSAGE, NOTIFY, OPTIONS, SUBSCRIBE request methods and relayed 3xx, 4xx, 5xx, and 6xx responses to INVITE methods. Provision this flag on the ingress leg with respect to the message direction.
  • disable (default)
  • enable

updateWithoutSdp

Enable this flag to relay UPDATE message without SDP.
  • disable (default)
  • enable


SIP Headers not Controlled Using Relay Flags

Refer to SBC SIP Transparency Implementation Guide for a list of SIP headers not controllable by relay (or transparency) flags in relay scenarios.


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.