This section lists SIP Common IP Attributes Flags details grouped alphabetically.
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.
The SBC gives precedence to SIP Privacy handling when the SIP Adaptive Transparency Profile is enabled. For example, if the incoming SIP message has "privacy: Id
" and the flag applyPrivacyId
under profiles services privacyProfile
is set to enabled
, the SBC does not include P-ASSERTED-ID
header in the egress message.
Several flags prevent the SBC from relaying a re-INVITE, or an UPDATE, to the other leg of the call. When you enable such flags, the behavior is contradictory to that of the SIP Adaptive Transparency Profile.
To resolve such conflicts, the SBC gives precedence to the SIP Adaptive Transparency Profile over the following flags:
profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags
relayDataPathModeChangeFromOtherCallLeg
minimizeRelayingOfMediaChangesFromOtherCallLegAll
disableMediaLockDown
lockDownPreferredCodec
callHoldInterworking
addressContext <addressContext_name> zone <zone_name> sipTrunkGroup <sipTrunkGroup_name> signaling
sdp100relIwkForPrack
rel100Support
addressContext <addressContext_name
> zone <zone_name
> sipTrunkGroup <sipTrunkGroup_name
> media
lateMediaSupport
For more information on SIP Adaptive Transparency Profile, refer to SIP Adaptive Transparency Profile - CLI.
Click a letter to go to the section listing all flags beginning with that letter.
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags acceptAlertInfo <disable | enable> addPChargingFuncAddr <disable | enable> addPathServiceRoute <disable | enable> aiToPemInterworking <enable | disable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags callHoldInterworking <disable | enable> clearmodeForDataCalls <disable | enable> contactTransparencyForIsFocusMediaTag <disable | enable> createPChargingVector <disable | enable> createPVisitedNetworkId <disable | enable> createPathHeader <disable | enable> createServiceRouteHeader <disable | enable> customizedSessionTimerBehavior <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags disableAlsoHeader <disable | enable> disableHostTranslation <disable | enable> disableMediaLockDown <disable | enable> disableReferToUriParameters <disable | enable> discardReceivedReasonHeader <disable | enable> doNotIncludeSsAttributeInReInvite <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags enableDefaultPUIProcedures <disable | enable> enableDialStringHandling <disable | enable> endToEndBye <disable | enable> endToEndPrack <disable | enable> endToEndReInvite <disable | enable> endToEndUpdate <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags fromHeaderAnonymisation <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags includeIpPortsInFromAndToHeaders <disable | enable> includeReasonHeader <disable | enable> includeSsAttributeInInitialInvite <disable | enable> includeTransportTypeInContactHeader <disable | enable> insertPAccessNetworkInfo <disable | enable> insertPeerAddressAsTopRouteHeader <disable | enable> insertUEFlowInfo <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags lockDownPreferredCodec <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags mapCauseLocation <disable | enable> mapSuspendResumeEventInPSvcInfoHeader <disable | enable> mapUuiInPSigInfoHeader <disable | enable> mimeCausePrecedeReasonHeaderCause <disable | enable> minimizeRelayingOfMediaChangesFromOtherCallLegAll <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags noContentDisposition <disable | enable> noPortNumber5060 <disable | enable> noServiceRouteHdrForEmergencyRegistration <disable | enable> noUserinfoInContactHeader <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags onlySelectedCodecInSessionRefresh <disable | enable>
Example: |
---|
--> The SBC sends an INVITE including Codec-A and Codec-B <-- An 18x message is received identifying Codec-B. --> The SBC sends a keep-alive reINVITE depending upon the flag setting:
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags pCalledPartyIDSupport <disable | enable> pChgMsgInfo <disable | enable> publishIPInHoldSDP <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags reQueryPsxOnRegisterRefresh <disable | enable> rejectRefer <disable | enable> relayDataPathModeChangeFromOtherCallLeg <disable | enable> replaceHostOnViaHeader <disable | enable> restrictHistoryInfoHeader <disable | enable> routeUsingRecvdFqdn <disable | enable>
Parameter | Description |
---|---|
reQueryPsxOnRegisterRefresh | When enabled, the SBC will re-query the SBC when it receives a register refresh message, which may result in a new or updated result for the register relay. When disabled, the SBC does not re-query the SBC on a register refresh. This setting must be made on the ingress trunk group profile facing the registered endpoint.
|
rejectRefer | When enabled, the SBC rejects SIP REFER messages from the peer and responds with a 405 Method Not Allowed message.
|
replaceHostOnViaHeader | Use flag to replace IP address of the top-most via header on the outgoing request with IP address or hostname present in the top-most via header received.
|
relayDataPathModeChangeFromOtherCallLeg | When this flag is enabled in conjunction with
NOTE: The |
restrictHistoryInfoHeader | Enable this flag to restrict History InfoHeader Flag depending upon the Privacy header or Privacy URI.
|
routeUsingRecvdFqdn | Enable flag to use the FQDN received in contact header of Refer-To/3xx for routing.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags sdpOlineOnlyCompares <disable | enable> sendAllAllowedCodecsForLateMediaInviteOrReInvite <disable | enable> sendDirectMediaInfoInSdpAttribute <disable | enable> sendOnlyPreferredCodec <disable | enable> sendPtimeInSdp <disable | enable> sendRTCPBandwidthInfo <disable | enable> sendRtcpPortInSdp <disable | enable> sendSBCSupportedCodecsForLateMediaReInvite <disable | enable> sessionTimerRefreshUpdate <disable | enable> setAcceptHeaderToApplicationSdpOnly <disable | enable> setOlineDash <disable | enable> setSessionVersionZero <disable | enable> setSlineDash <disable | enable> skipPsxQueryForRefer <disable | enable> storePChargingFuncAddr <disable | enable> storePChargingVector <disable | enable> storePathHeader <disable | enable> storeServiceRouteHeader <disable | enable> supportSCSCFRestorationProcedures <disable | enable> suppressE2ESessionRefresh <disable | enable> suppressMinSeIfNotReceived <disable | enable>
Parameter | Description |
---|---|
sdpOlineOnlyCompares | When enabled, the SBC checks only the o-line when comparing SDPs. When disabled, the SBC checks the entire SDP body when comparing SDPs.
|
sendAllAllowedCodecsForLateMediaInviteOrReInvite | The
For pass-through calls, the SBC always offers a subset of the codecs advertised by the associated peer. The SBC Offer codec list is classified as a subset because the list applies the codec policy filters. Configuration options:
NOTE: Refer to SDP Support for examples of the above behavior. |
sendDirectMediaInfoInSdpAttribute | Enable flag to send direct media information in the SDP attribute X-DMI.
Note
The 'directMediaAllowed' flag must be disabled on the associated trunk group. Caution
You must enable the
|
| Enable this flag on Answer side to send a single preferred codec in an Answer for an Initial Offer or Re-Invite. Enable flag on Offer side to send the most preferred codec in a re-INVITE offer. When disabled, the SBC sends all possible pass-through codecs in the route Packet Service Profile when the call is answered. This flag is used primarily in pass-through cases where more than one pass-through codec is possible. When generating an answer, the SBC chooses the most preferred codec based on the ordered list created by Send Route Preference (SRP)/Honor Remote Preference (HRP). Note that when this flag is disabled SBC sends all possible pass-through codecs in the answer or the Route Packet Service Profile when generating a re-INVITE offer. For offers generated by the SBC, especially in HOLD/RESUME cases, only the most preferred codec is sent in a re-INVITE offer when this flag is enabled.
|
sendPtimeInSdp | Enable flag to allow the SBC to send a=ptime in the SDP. This parameter takes effect only when the trunk group parameter, directMediaAllowed , is disabled.
Note: If the flag is enabled in the ingress IP signaling profile only, the SBC only sends the ptime attribute in the SDP in the ingress signaling. However, if the flag is enabled in the egress IP signaling profile, the SBC sends the ptime attribute in the SDP in both the ingress and egress signaling. |
| Enable flag to send the RR and RS bandwidth information, as well as "b=RR:" and "b=RS:" in the SDP offer.
|
sendRtcpPortInSdp | When enabled, the SBC adds the attribute,a=rtcp:<rtcpPort> to the audio and video m lines in the outgoing SDP (Rtcp port mentioned will be SBC RTP port + 1).
|
sendSBCSupportedCodecsForLateMediaReInvite | This flag determines if the SBC includes all pass-through and transcodable codecs supported on that leg in the SDP offer sent in the 200 OK response to a late media Re-INVITE request.The options are:
This flag takes precedence over the sendAllAllowedCodecsForLateMediaInviteOrReInvite flag and the sendOnlyPreferredCodec flag in the IP Signaling profile. The SIP trunk group media flag lateMediaSupport must be set to convert for the behavior enabled by the sendSBCSupportedCodecsForLateMediaReInvite flag to apply. |
sessionTimerRefreshUpdate | Enable flag to control session timer refresh method with SIP peers via UPDATE messages. When disabled, the SBC sends INVITE messages.
|
setAcceptHeaderToApplicationSdpOnly | Use flag to specify the Accept header format in SIP messages expected by the remote peer. When enabled, the remote peer receives a short Accept header format containing the application/SDP value only. When disabled, the remote peer receives the standard Accept header format containing all of the standard parameters.
|
setOlineDash | Specifies the SDP O-Line format in the SDP of SIP messages expected by the remote peer. When enabled, the remote peer receives an O-Line format in which the username component is set to a "-" (dash). When disabled, the remote peer receives the standard O-Line format containing all of the O-Line parameters, including the username.
|
setSessionVersionZero | Enable flag to set the session version to zero in the o-line of the outbound SDP. When disabled, the SBC assigns a session version randomly.
|
setSlineDash | Specifies the SDP S-Line format in the SDP of SIP messages expected by the remote peer.
|
skipPsxQueryForRefer | Set flag to skip the ERE query for Refer flag.
|
storePChargingFuncAddr | Set this flag to store the values received in the PCFA header in a request or response. The stored value is added to a subsequent response or a request based on the flag addPChargingFuncAddr .
|
storePChargingVector | When this flag is enabled, the SBC stores the P-Charging-Vector (PCV) received in requests. When the response is forwarded back, the stored PCV is inserted and sent. If the SBC receives the PCV when this flag is disabled, the SBC ignores the PCV and does not log the CDR.
Example of SBC acting as IBCF: INVITE (PCV1) --> SBC --> INVITE |
storePathHeader | Set this flag to locally store (cache) a Path header received in an incoming REGISTER request.
|
storeServiceRouteHeader | Set this flag to locally store (cache) a Service-Route header received in an incoming 200 OK response to REGISTER.
|
supportSCSCFRestorationProcedures | SBC acting as P-CSCF rejects a request with 504 (Server Time-out) response carrying MIME body of type
|
suppressE2ESessionRefresh | When the This flag is only available when the "End To End Update" and/or the "End to End Re Invite" flags are enabled. The SBC applies this flag on both the ingress and egress legs even if it is enabled on just one IPSP.
Refer to UPDATE and reINVITE Suppression for additional feature details. |
suppressMinSeIfNotReceived | Enable flag to add Min-SE header to re-INVITEs/UPDATEs only if it exists in the previous offer/answer. When this flag is disabled, Min-SE is always added to session refreshes.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags terminalPortabilityInterworking <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags usePsxRouteforRegisteredInvite <disable | enable>
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags validateAccessNwInfoHeader <disable | enable>