This section lists SIP Common IP Attributes Flags details grouped alphabetically.
Click a letter to go to the section listing all flags beginning with that letter.
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.
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags acceptAlertInfo <disable | enable> addPChargingFuncAddr <disable | enable> addPathServiceRoute <disable | enable>
Parameter | Description |
---|---|
acceptAlertInfo | Enable flag for SBC to process the URI specified in the Alert-info header received in the 180 ringing message and use the tone specified in the Alert-Info header as the Local Ring Back Tone to play.
When this flag is enabled, the tones processed override any incoming tones in the media stream. For example, when Accept Alert-Info is enabled, the SBC plays the tone specified in the Alert-info header of 180 ringing message overriding the inband tones included in the 180 ringing message. When using PSX in your network, enable the |
addPChargingFuncAddr | Set (enable) this flag to add the stored value of the PCFA header to a request or response.The PCFA header value is stored based on the flag.
|
addPathServiceRoute | Enable this flag to allow Unable to show "metadata-from": No such page "_space_variables" acting as P-CSCF or IBCF to add two Path headers in REGISTER request towards the Core (createPathHeader must be enabled) OR allow Unable to show "metadata-from": No such page "_space_variables" acting as IBCF to add two Service-Route headers in 200 OK response for REGISTER towards the P-CSCF (createServiceRouteHeader must be enabled).
When Unable to show "metadata-from": No such page "_space_variables" does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled. |
% 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>
Parameter | Description |
---|---|
callHoldInterworking | Set flag to enable Call Hold Interworking service between ISUP and SIP. The service converts an ISUP call hold to an SIP call hold, or vice-versa. Call holds are invoked by ISUP or SIP/H.323 endpoints. When disabled, call hold indications are dropped.
|
clearmodeForDataCalls | Set flag to enable the clearmode function for data calls.
|
contactTransparencyForIsFocusMediaTag | Enable flag to transparently pass Contact header for all requests and responses in outgoing message when "isFocus" parameter is received in Contact header.
This flag is configurable from ePSX or external PSX. |
createPChargingVector | Enable flag to create a new PCharging-Vector header in outgoing message for INVITE and REGISTER messages. The PCharging-Vector header is also supported in SUBSCRIBE, OPTIONS, NOTIFY, MESSAGE, PUBLISH and REFER messages when received from same direction as REGISTER message. The P-Charging-Vector header contains the ICID value, ICID Generated at value and orig-ioi value. The string for orig-ioi value can be configured at egress trunk group.
|
createPVisitedNetworkId | Enable flag to allow Unable to show "metadata-from": No such page "_space_variables" acting as P-CSCF to insert a P-Visited-Network-ID Header in the egress REGISTER request with the P-Visited-Network-ID configured string.
|
createPathHeader | Enable flag to create a new Path header in the outgoing REGISTER request.
|
createServiceRouteHeader | Enable flag to create a new Service-Route header in the outgoing 200 OK response for REGISTER.
When Unable to show "metadata-from": No such page "_space_variables" does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled. |
customizedSessionTimerBehavior | When enabled, the remote peer expects customer-specific session timer behavior. When disabled, the remote peer expects the standard session timer behavior.
|
% 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>
Parameter | Description |
---|---|
disableAlsoHeader | Enable this flag to allow Unable to show "metadata-from": No such page "_space_variables" to ignore the Also header if received from the remote peer and Unable to show "metadata-from": No such page "_space_variables" does not send the Also header to the remote peer. When disabled, the Unable to show "metadata-from": No such page "_space_variables" uses the Also header for call forwarding as usual.
|
disableHostTranslation | Use this flag to enable/disable host name translation. This applies to all URL style headers that require transparency and defines the processing that SBC is to apply to the host name portion of these headers before forwarding.
|
disableMediaLockDown | Enable this flag to allow Unable to show "metadata-from": No such page "_space_variables" to disable media lock-down by not sending SIP Re-INVITE/UPDATE messages in the following scenarios:
If the result is a pass-through codec, and the most preferred codec in the answer (first codec in the list) is same as the selected codec, the Unable to show "metadata-from": No such page "_space_variables" disables media lock-down by not informing the egress peer using a re-INVITE.If the Unable to show "metadata-from": No such page "_space_variables" offers both pass-through and transcoding codecs, the minimizeRelayingOfMediaChangesFromOtherCallLegAll flag effectively suppresses the re-INVITEs to peers when the peer answers with a single codec. However, if the peer has multiple codecs, the minimizeRelayingOfMediaChangesFromOtherCallLegAll flag in certain situations cannot suppress the re-INVITEs as a change in one of the common codecs is detected. In these situations, if the Unable to show "metadata-from": No such page "_space_variables" ’s most preferred codec matches the peer's most preferred codec, enable the disableMediaLockDown flag to suppress this Modify Offer initiated by the Unable to show "metadata-from": No such page "_space_variables" to lock down the codec.If this flag is disabled, the Unable to show "metadata-from": No such page "_space_variables" sends a modify offer to lock down the codec.
|
disableReferToUriParameters | By default, this flag is disabled thereby allowing parameters in the SIP URI Refer-To header to pass through to the outgoing INVITE URI. Enable this flag to prevent the parameters from passing through.
|
discardReceivedReasonHeader | Enable flag to ignore cause code in received Reason header. When disabled, the Unable to show "metadata-from": No such page "_space_variables" uses the cause code in the received Reason header.
|
doNotIncludeSsAttributeInReInvite | Enable flag to prevent Unable to show "metadata-from": No such page "_space_variables" from sending silence suppression (no a=silenceSupp is sent) in the SDP to the remote peer. When disabled, and when silence suppression is off, the Unable to show "metadata-from": No such page "_space_variables" sends a=silenceSupp:off in the SDP to the remote peer.
a=silenceSupp:on is never sent to remote peer in current implementation when silence suppression is on. |
% 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>
Parameter | Description |
---|---|
| Enable this flag to maintain the most preferred codec of the leg on which it is enabled even if it requires transcoding. This feature also suppresses the re-INVITE triggered on the leg (on which it is enabled from the SBC) due to a MODIFY offer received from the other leg as part of mid-call codec modification.
This flag must be enabled in conjunction with When this flag is enabled, the flag “ |
% 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>
Parameter | Description |
---|---|
noContentDisposition | The Content Disposition header format in SIP messages expected by the remote peer. When enabled, the remote peer expects no Content Disposition header. When disabled, remote peer expects the standard SIP message format which includes Content Disposition header.
|
noPortNumber5060 | Use this parameter to control whether port number 5060 is sent to the remote peer in the Request-URI of PRACK, ACK, and BYE messages. When enabled, the outgoing SIP URI does not include port number 5060 (sip:user@host). In addition, Unable to show "metadata-from": No such page "_space_variables" only sends out the Record-Route and Route headers of SIP request and response messages with the port number it receives, such that if the Unable to show "metadata-from": No such page "_space_variables" does not receive a port number in Record-Route headers, the Unable to show "metadata-from": No such page "_space_variables" does not send out a port number in the Record-Route and Route headers. When disabled, the outgoing SIP URI includes port number 5060 (sip:user@host:5060). In addition, if SBC does not receive a port number in Record-Route headers of SIP request and response messages, the Unable to show "metadata-from": No such page "_space_variables" inserts port number 5060 into the outgoing Record-Route and Route headers.
Enable this flag to allow DNS NAPTR/SRV lookups. |
| When this flag is enabled, Unable to show "metadata-from": No such page "_space_variables" does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled.
|
noUserinfoInContactHeader | When this flag is enabled, the remote peer expects no userinfo component in the Contact header URI. When disabled, the remote peer expects the standard format of the Contact header, which includes the userinfo component.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags onlySelectedCodecInSessionRefresh <disable | enable>
Parameter | Description |
---|---|
onlySelectedCodecInSessionRefresh | When this flag is enabled, the SDP in a session keep-alive re-INVITE message will only include the currently-selected codec for the call. When disabled, the SDP in a session keep-alive re-INVITE message will be identical to that in the last offer. See example below.
The o-line of the SDP will be identical to that in the last offer. |
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 Unable to show "metadata-from": No such page "_space_variables" will re-query the Unable to show "metadata-from": No such page "_space_variables" when it receives a register refresh message, which may result in a new or updated result for the register relay. When disabled, the Unable to show "metadata-from": No such page "_space_variables" does not re-query the Unable to show "metadata-from": No such page "_space_variables" on a register refresh. This setting must be made on the ingress trunk group profile facing the registered endpoint.
|
rejectRefer | When enabled, the Unable to show "metadata-from": No such page "_space_variables" 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
The
relayDataPathModeChangeFromOtherCallLeg flag is only available when minimizeRelayingOfMediaChangesFromOtherCallLegAll is enabled. |
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> 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> 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. Refer to SDP Support for examples of the above behavior. Configuration options:
|
sendDirectMediaInfoInSdpAttribute | Enable flag to send direct media information in the SDP attribute X-DMI.
The 'directMediaAllowed' flag must be disabled on the associated trunk group. |
| 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.
|
| 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, Unable to show "metadata-from": No such page "_space_variables" 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).
|
sessionTimerRefreshUpdate | Enable flag to control session timer refresh method with SIP peers via UPDATE messages. When disabled, the Unable to show "metadata-from": No such page "_space_variables" sends INVITE messages.
This flag is only accessible when the flag " |
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 Unable to show "metadata-from": No such page "_space_variables" 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: |
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
|
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>