In this section:

Related articles:


Use this object to define the parameters associated with the Media features for this SIP trunk group.

Note

As a best practice, always use UPPERCASE for trunk group names.



Note

The SBC 5400 and SBC 7000 systems support creating IP Interface Groups containing sets of IP interfaces that are not "processor friendly" (i.e. carried on physical Ethernet ports served by separate processors). However, restrictions exist regarding the usage of such Interface Groups.

For complete details, refer to Configuring IP Interface Groups and Interfaces.

SIP Trunk Group Media

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> media
	advertiseAudioOnly <disabled | enabled>
	anat 
		answerPreference <honorRecvPrec | iPv4 | iPv6 | matchSigAddrType>
		offerPreference <iPv4 | iPv6 | matchSigAddrType>
	appSpecificBandwidth <disabled | enabled>
    comediaConnectionRole <active | none | passive>
	dataPathModePassthru <disabled | enabled>
	directMediaAllowed <disabled | enabled>
	directMediaAllowedBehindNapt <disabled | enabled>
	directMediaAntiTrombone <disabled | enabled> 
	directMediaGroupId <#>
	disallowSrtpStream
    dtlsProfileName <profile name>
	earlyMedia 
	ice
	lateMediaSupport <convert | passthru>
	multipleAudioStreamsSupport
    lyncShare <disabled | enabled>
	maxPtimeDefault <#>
	mediaAddrType <iPv4 | iPv6 | iPv4andiPv6 | matchSigAddrType>
	mediaIpAddress <IPv4 or IPv6 address>
	mediaIpInterfaceGroupName <IPIG name>
    mediaIpSecondaryInterfaceGroupName <IPIG name>
	mediaPortRange
		baseUdpPort <1024-65534, or "none">
		maxUdpPort <1024-65534, or "none">
	msrp <disabled | enabled>
    msrpMux <disabled | enabled>
	omrAllowed <disabled | enabled | ravelCallOnly>
	omrPrimaryRealm <OMR primary realm name>
	pcrf 
	recordable <disabled | enabled>
    relayUnknownAttrsForAudioTrancodeCalls <disabled | enabled>
	sdpAttributesSelectiveRelay <disabled | enabled>
	sourceAddressFiltering <disabled | enabled>
	tcpPortRange
		baseServerPort <1-65534, or "none">
		maxServerPort <1-65534, or "none">
	tmr64K <disabled | enabled>


Command Parameters

SIP Trunk Group Media Parameters


ParameterLength/RangeDescription

advertiseAudioOnly

N/A

Enable flag to suppress non-audio streams and send only the main audio/image stream in the SDP offer. This flag controls both the initial and subsequent offers.

  • disabled (default) 
  • enabled
anatN/A

Alternative Network Address Types (ANAT) configuration options.  

  • answerPreference – Answer version preference when SDP method is ANAT.
    • honorRecvPrec – Select this option to choose the first received IP version in the SDP answer within ANAT address format.
    • iPv4 – If selected, IPv4 version appears first in SDP within ANAT address format. IPv6 port number is set to 0 (in ANAT format)
    • iPv6 – If selected, IPv6 version appears first in SDP within ANAT address format. IPv4 port number is set to 0 (in ANAT format)
    • matchSigAddrType (default) – Select this option to match the address type (IPv4 or IPv6) used for signaling.
  • offerPreference– Offer version preference when SDP method is ANAT.
    • iPv4  – If selected, IPv4 version appears first in SDP within ANAT address format. IPv6 port number is set to 0 (in ANAT format)
    • iPv6  – If selected, IPv6 version appears first in SDP within ANAT address format. IPv4 port number is set to 0 (in ANAT format)
    • matchSigAddrType (default) – Select this option to match the address type (IPv4 or IPv6) used for signaling.

Note: The anat object is only available when  mediaAddrType is set to iPv4andiPv6.


Note

Ribbon recommends to avoid configuring both Media Nat and ICE Support on the same Trunk Group because these configurations are independent mechanisms for solving NAT traversal issues. Because of of this, these configurations should not coexist on the same Trunk Group.

appSpecificBandwidthN/A

Enable this flag on a trunk group to include the b=AS attribute in the SDP outgoing offer or answer sent on that trunk group.

  • disabled (default)
  • enabled

This flag does not insert the b=AS SDP attribute for non-audio streams or at the session level. The b=AS SDP attribute does not apply to the H.323 signaling interface.

comediaConnectionRoleN/A
This indicates whether the SDP offer sent by SBC includes any direction attribute line defined by COMEDIA draft.
  • active – The SDP offer will include "a=direction: active" attribute line.
  • none – The SDP offer will not include a direction attribute line.
  • passive – The SDP offer will include "a=direction: passive" attribute line.
dataPathModePassThru N/A
Specifies whether the SBCwill transparently pass media direction (Data Path Mode) received from a peer in the Offer SDP RTP IP.
  • disabled (default)
  • enabled
directMediaAllowedN/A

If enabled, attempt to set up a direct-media path so that media flows directly between endpoints in the same direct-media group.

  • disabled (default) 
  • enabled
directMediaAllowedBehindNaptN/A

If enabled, attempt to set up a direct-media call for endpoints behind NAT.

  • disabled (default)
  • enabled
directMediaAntiTromboneN/A

Enable flag on trunk groups facing AS to allow direct media using C-line trigger (e.g. media anti-trombone).

  • disabled (default)
  • enabled

Note: Direct Media configuration (directMediaAllowed flag) must be enabled on trunk groups facing the endpoints for this feature to function.

directMediaGroupId0-65535

This identifies the direct media group to which this trunk group belongs.(default = 0).

disallowSrtpStream


Determines whether the SBC forwards SRTP streams on egress when they are received in the incoming SDP, or if it sets the port to zero, thus disabling the SRTP stream. The options are:

  • disabled (default)
  • enabled

Note: Users no longer have to enable the multipleAudioStreamSupport flag to configure the disallowSrtpStream flag. You can enable the disallowSrtpStream flag independently. However, the disallowSrtpStream flag will have an impact on the call flows only when any one of the two flags below are enabled:

  • selectCoreStreamForMultiStreamAudioOrImageCall under IPSP. Refer to Flags - CLI for details about this flag.
  • multipleAudioStreamSupport under TrunkGroup

When enabled, the disallowSrtpStream flag takes the first precedence.

dtlsProfileName1-23<profile name> – Name of DTLS Profile to associate with this SIP trunk group.
earlyMediaN/A

Use this object to configure early Media support. See Early Media Parameters table below for details.

iceN/A

ICE SDP grouping method options. See ICE Parameters table below for details.

lateMediaSupport N/A

Use this parameter on the ingress trunk group to determine whether a SIP late media (reverse offer) INVITE is converted to a forward offer on egress or else allowed to transparently pass through.

  • convert (default) –  (This option applies to Audio. For multimedia sessions, choose “passthru” mode)
  • passthru


Note:

  • If you configure Packet Service Profile packetToPacketControl for “transcodeFreeTransparency” (see Packet Service Profile - CLI), ensure you also set lateMediaSupport to ‘passsthru’.
  • When lateMediaSupport is set to convert and directMediaAllowed flag is enabled for the same call, the late media convert takes precedence for the original egress INVITE being generated. Eventually, the call transitions to a direct media call.
  • The SBC gives precedence to SIP Adaptive Transparency Profile over this flag.
lyncShareN/A

This parameter supports Lync/Desktop sharing application media streams.

  • disabled – lyncShare media streams are not allowed for the specified Trunk Group.
  • enabled (default) – lyncShare media streams are allowed for the specified Trunk Group.

Refer to Configuring SBC and LYNC in Media Environment for configuration details.

maxPtimeDefault 10-150This parameter indicates the default packet size in milliseconds. (default = 150).
mediaAddrType N/A

The Media Address Type attribute determines the type of IP address used in the offer. 

  • iPv4 – IPv4 address is selected from the media interface group for the SDP, or else call fails.
  • iPv6 – IPv6 address is selected from the media interface group for the SDP, or else call fails.
  • iPv4andiPv6 – Both address types are allowed.
  • matchSigAddrType (default) – Select this option to match the address type (IPv4 or IPv6) used for signaling.
mediaIpAddressIPv4/IPv6

Each trunk group can have a mediaIpAddress configured to specify a specific IP address to use when allocating UDP or TCP media. Default is "0.0.0.0".

The mediaIpAddress can be configured as either an IPv4 or IPv6 address (except for H.323 which does not support IPv6 addresses). Any IP address configured must belong to the ipInterfaceGroup configured as the mediaIpInterfaceGroupName for the trunk group. For additional details, see SIP over UDP and SIP over TCP.

Note: If you prefer to instead choose an IP Address from a range of values configured in mediaPortRange (UDP) or tcpPortRange, use the default value “0.0.0.0” for mediaIpAddress parameter.

Note: Does not apply to D-SBC.

mediaIpInterfaceGroupNameN/AName of the IP interface group for media, up to 23 characters. The specified name must be the name of a valid, existing ipInterfaceGroup. 

mediaIpSecondaryInterfaceGroupName

 N/ASpecifies the name of a secondary (or public/external address) IP interface group to use for media for calls involving the Microsoft Teams Phone System.
mediaPortRangeN/A

Use this media control to set the baseUdpPort and maxUdpPort RTP/RTCP ranges for the specified SIP trunk group.

  • baseUdpPort – The starting (base) port number for the range of UDP ports to use for RTP/RTCP media (inclusive). This value must be within the system-wide media port range. The baseUdpPort range is 1024-65534, or "none" (the default value which indicates SBC does not apply this SIP trunk group control, and instead uses the mediaPortRange specified by system-wide settings).
  • maxUdpPort – The maximum UDP port number for the range of UDP ports to use for RTP/RTCP media (inclusive). This value must be greater than the baseUdpPort and within the system-wide media port range. The maxUdpPort range is 1024-65534, or "none" (the default value which indicates SBC does not apply this SIP trunk group control, and instead uses the mediaPortRange specified by system-wide settings.

NOTE: When provisioning a UDP media port range, set the range slightly larger than the actual number of ports needed to support maximum simultaneous calls.

msrpN/A

This flag is enabled by default allowing MSRP payload relay over TCP connections upon successful negotiation of MSRP SDP attributes.

  • disabled 
  • enabled (default)
msrpMuxN/A

Enable this flag to reuse an existing TCP connection with an IP peer for multiple MSRP sessions (MSRP multiplexing). MSRP multiplexing applies only to MSRP sessions established using back-to-back user agent (B2BUA) behavior. Multiplexing cannot be applied to MSRP sessions established based on the RFC 6714 “Connection Establishment for Media Anchoring” (CEMA) type of handling. The options are:

  • disabled (default)
  • enabled
multipleAudioStreamsSupportN/A

This flag determines whether the SBC processes multiple audio m-lines, or a combination of audio and image m-lines, in SDP. The options are:

  • enabled
  • disabled (default)
omrAllowedN/A

Use this parameter to specify when to apply OMR procedures. (see Configuring SBC to Apply OMR Rules for additional details)

  • disabled (default) – If this parameter is disabled OMR procedures are not applied to any call. This parameter is disabled by default for backward compatibility.
  • enabled – If this parameter is enabled, OMR procedures are applied to all the calls.
  • ravelcallOnly – OMR procedures are applied only to ravel calls.


Note: The omrAllowed and directMediaAllowed parameters are mutually exclusive in a Sip Trunk Group. SBC considers OMR as enabled when omrAllowed parameter in the Trunk Group is not set to 'disabled' and a realm name is associated with the Trunk Group, plus useDirectMedia parameter in the Packet Service Profile is enabled. Even if OMR is enabled on one side but not the other, OMR procedures are applied for bypassing any previous nodes, but are prevented from passing the OMR-specific SDP attributes towards the unsupported side.

Note: The PSX flag Send Direct Media Info In SDP in the IP Signaling Profile is used to control sending the OMR attributes to the peer. If OMR is enabled and Send Direct Media Info In SDP is not enabled, SBC still performs all the OMR procedures, but removes the OMR attributes from the SDP before sending the offer/answer.



Note

The ERE is not supported for this configuration. You must use an external PSX.

omrPrimaryRealm N/A

<OMR primary realm name> – Use this parameter to choose which Address Context realm name to use as the primary realm for this SIP trunk group when employing OMR procedures. (see Configuring SBC to Apply OMR Rules for additional details)


Note

The ERE is not supported for this configuration. You must use an external PSX.

pcrfN/A

Use this object to define Policy and Charging Rules Function (PCRF) parameters. See PCRF Parameters table below for details.

recordable N/A

Enable flag to support media recording of RTP stream to an external recording device on this SIP trunk group.

  • disabled (default)
  • enabled
relayUnknownAttrsForAudioTrancodeCallsN/A

Use this flag to specify whether or not to relay of unknown SDP attributes in the core audio stream for transcoded calls. Options are:

  • disabled (default) –  When this flag is disabled the SBC drops unknown SDP attributes in messages in the core audio stream for transcoded calls.
  • enabled  – When this flag is enabled for the ingress SIP trunk group, the SBC relays unknown SDP attributes in the core audio stream in the egress INVITE request. When enabled for the egress SIP trunk group, the SBC relays unknown SDP attributes in the core audio stream in 18x or 200 OK responses it sends to the ingress leg.
sdpAttributesSelectiveRelay
N/AEnable this flag to control the selective relay of unknown SDP attributes at session level and selective relay of unknown SDP attributes in the core audio stream.
  • disabled (default) – Session level attributes are dropped. Media stream level attributes are dropped unless from a non-core stream.
  • enabled – All qualified session level and media stream level attributes are relayed (including attributes from a= and b= lines).
sourceAddressFiltering N/A

When enabled, incoming media packets which do not match the expected source IP address and UDP/TCP port are filtered out.

  • disabled 
  • enabled (default)
tcpPortRangeN/A

Use this media control to set the baseServerPort and maxServerPort of a TCP port range for the specified SIP trunk group. This TCP port range is used by the SBC to advertise its TCP port on which it can accept connections.

  • baseServerPort – The starting (base) port number for the range of TCP ports to use for media. The baseServerPort range is 1-65534, or "none" (the default value which indicates SBC does not apply this SIP trunk group control, and instead uses the tcpPortRange specified by system-wide settings.
  • maxServerPort – The maximum TCP port number for the range of TCP ports to use for media. This value must be greater than the baseServerPort.. The maxServerPort range is 1-65534, or "none" (the default value which indicates SBC does not apply this SIP trunk group control, and instead uses the tcpPortRange specified by system-wide settings.
tmr64K N/A

Enable this flag to allow the transmission Medium Requirement Unrestricted 64kbit/s control for SIP-ISUP interworking.

  • disabled (default)
  • enabled

Early Media

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> media earlyMedia 
	forkingBehaviour <firstProvResponse | firstRtp | lastReceivedSdp | pemPriority>
	relayPemState <disabled | enabled>
	suppressGatedParam <disabled | enabled>
	method 
		pEarlyMedia 
			defaultGatingMethod <inactive | none | recvonly | sendonly | sendrecv>
			egressSupport <disabled | enabled>
		rtpServerTable rtpServerTableName
		sessionAnswer

Command Parameters

Early Media Parameters


ParameterDescription
forkingBehaviour

Use this parameter to identify the method to provide early dialog media selection.

  • firstProvResponse – First Reliable Provisional response. Cut through for first provisional response and suppress the rest until final response is received.
  • firstRtp – When this option is selected, the SBC's selection of provisional response for cut-through is determined by the arrival of media packets corresponding to that provisional response. Select this option and set dynamicLRBT flag to 'enabled' when forking is enabled. With firstRtp enabled, forking behavior is the last provisional response until 180 is received. If firstRtp is enabled, but dynamicLRBT flag is disabled, forking behavior defaults to the last provisional response
  • lastReceivedSdp (default) – Last Reliable Provisional response. Cut-through based on last received SDP.
  • pemPriority – PEM (P Early Media) based. Cut through occurs based on the value of the PEM header (default value is sendrecv if not configured).
relayPemState

Disable this flag to suppress the P-Early Media (PEM) Legacy behavior.

  • disabled - If this Flag is disabled, the SBC sends the PEM in Ingress if the PEM is received on Egress. If the PEM is not received on Egress it does not send the PEM in Ingress.
  • enabled (default)

Exceptions:

  • For alert information to PEM interworking scenarios, this flag has less precedence.
  • If the SBC is playing Tone, then this flag has less precedence.
suppressGatedParam

If this flag is enabled, the SBC does not sends the Gated Param in PEM towards Ingress. 

  • disabled (default)
  • enabled
method

Select a method to use to provide early media.

  • pEarlyMedia – P-Early-Media (PEM) header value is used for selecting the RTP streams.
    • defaultGatingMethod – Select an option to specify the cut-through method if p-early-media header is not received from peer.
      • inactive
      • recvonly
      • sendonly
      • sendrecv (default)
    • egressSupport – Use this flag to include PEM-supported message in the egress INVITE.
      • disabled – Egress INVITE does not include PEM-supported message regardless of the presence/absence of PEM in the ingress INVITE.
      • enabled (default) – Egress INVITE includes PEM-supported message regardless of the presence/absence of the PEM in the ingress INVITE.
    • monitorRtp - Monitor RTP for early media authorization when the flag defaultGatingMethod is set to none. The options are:
      • disabled (default)
      • enabled
  • rtpServerTable – Enter an RTP Server Table name to specify the RTP server profile. This option uses RTP Server Profile to determine whether early media is enabled. If the c-line of the session description matches an   entry in the RTP profile, early media is allowed. RTP Server Profiles are configured per Address Context. One RTP Server Profile is tied to a single Early Media Profile if this option is selected.
  • sessionAnswer (default) – Use this option for media cut-through on receipt of session answer.

ICE

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> media ice
	answerPreference <honorRecvPrec | ipv4 | ipv6 | matchSigAddrType>
	offerPreference <ipv4 | ipv6 | matchSigAddrType>


Command Parameters

ICE Parameters


ParameterDescription
answerPreference

This parameter determines which IP version to use for calls when multiple versions are specified using candidate lines for host type in answer.

  • honorRecvPrec – Received IP version appears in default c-line and in the candidate line in the SDP.

  • ipv4 – The IPv4 version appears in the default c line and in the candidate line.

  • ipv6 – The IPv6 version appears in the default c line and in the candidate line.

  • matchSigAddrType (default) – Selects media IP based on the signaling IP version used for the call. When the SIP peer IP type is known, the media IP will match it. When the SIP peer IP version is unknown, the media IP matches the IP version used for signaling (for example, IPv4 first and IPv6 for resolving an FQDN) for the call attempt. When “Signaling IP version mismatch” results in a collision crank back, the SBC reselects media IP to match the new signaling IP version.

offerPreference

This parameter determines which IP version appears first in the SDP offer.

  • ipv4 – The IPv4 version appears in the default c line and in the candidate line.  
  • ipv6 – The IPv6 version appears in the default c line and in the candidate line.
  • matchSigAddrType (default) – Selects media IP based on the signaling IP version used for the call. When the SIP peer IP type is known, the media IP will match it. When the SIP peer IP version is unknown, the media IP matches the IP version used for signaling (for example, IPv4 first and IPv6 for resolving an FQDN) for the call attempt. When “Signaling IP version mismatch” results in a collision crank back, the SBC reselects media IP to match the new signaling IP version.

 

The ice object is only available when  mediaAddrType is set to iPv4andiPv6 and the sipTrunkGroup services' iceSupport parameter is set to iceLync.

For example, the following commands are used to enable the ice parameter for the address context AC1 with the zone "Zone1" and "SipTrnkGrp1" SIP trunk group:

% set addressContext AC1 zone Zone1 sipTrunkGroup SipTrnkGrp1 media mediaAddrType iPv4andiPv6
% set addressContext AC1 zone Zone1 sipTrunkGroup SipTrnkGrp1 services natTraversal iceSupport iceLync

Now, the ice object can be set:

% set addressContext AC1 zone Zone1 sipTrunkGroup SipTrnkGrp1 media ice

Possible completions:

  answerPreference - Answer version precedence when SDP method is ICE
  offerPreference  - Offer version precedence when SDP method is ICE

Note

Ribbon recommends to avoid configuring both Media Nat and ICE Support on the same Trunk Group because these configurations are independent mechanisms for solving NAT traversal issues. Because of of this, these configurations should not coexist on the same Trunk Group.

PCRF

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> media pcrf 
	cushionNullSdp <disabled | enabled>
	cushionPacketSize <disabled | enabled>
	fetchLocationInfo <none | retrieveInOffer | retrieveInAnswer>
	pcrfCommitment <none | required | supported>
	pcrfInteractionMode <synchronous | asynchronous>
	pcrfRealm <DIAMETER domain>
	pcrfSendAarOnlyForSessionAnswer <disabled | enabled>
	provSignalingFlow <disabled | enabled>
	signallingPath <disabled | enabled>
	terminateOnNwFailure <disabled | enabled>

Command Parameters

PCRF Parameters


ParameterDescription
cushionNullSdp

Enable flag to allow Authorization/Authentication Request (AAR) when initial call setup is an INVITE which lacks SDP (estimate G.711 10 msec as a worst case). Disable flag to wait for reverse offer.

  • disabled (default)
  • enabled
cushionPacketSize

Enable flag to use the smallest packet size in an answer from the range supported for each codec for bandwidth estimate.Disable flag to use packet size in offer. 

  • disabled (default) 

  • enabled 

Note: Enabling this option may avoid rejecting an answer because its AAR fails even though the offer AAR succeeds, and also to abort a call after ringing the destination.

fetchLocationInfo

Specify when P-CSCF requests Location information.

  • none (default) – P-CSCF does not request for Location information.
  • retrieveInOffer – P-CSCF requests Location information in the Initial AAR.
  • retrieveInAnswer – P-CSCF requests Location information in the Final AAR.
pcrfCommitment

The degree of commitment expected from the PCRF during call setup or call update. 

  • none (default) – Do not send AAR. 
  • required – Send AAR; proceed only if it succeeds. 
  • supported – Send AAR; proceed even if it fails.
pcrfInteractionMode

Use this object to specify whether PCRF interaction is synchronous or asynchronous.

  • synchronous (default) – SBC sends INVITE message to egress once it receives the response for the AAR which is sent towards PCRF.
  • asynchronous – SBC sends INVITE message to egress after sending an AAR request. SBC continues with call processing without waiting for any response from the PCRF or time-out of the transaction. The final AAR is sent after receiving the session answer even though the answer or time-out for the preliminary AAR is not received.
pcrfRealm <string>The DIAMETER domain of a Policy and Charging Rule Function (up to 127 characters).
pcrfSendAarOnlyForSessionAnswer

Use this flag to control the sending of AAR messages. 

  • disabled (default) – SBC sends an AAR message upon receipt of an initial INVITE with a session offer, or upon receipt of an initial INVITE without a session offer (if the parameter cushionNullSDP is enabled) and upon receipt of session answer.
  • enabled – SBC sends an AAR message only after receiving the session answer.
provSignalingFlow

Enable flag to send P-Access-Network-Info header.

  • disabled (default)

  • enabled

signallingPath

Enable flag to subscribe for the Signaling Bearer Events.

  • disabled (default)

  • enabled

terminateOnNwFailure

Enable flag to terminate call on receiving TEMPRARY_NETWORK_FAILURE in AAA.

  • disabled (default)

  • enabled