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.
The Transparency Profile is the recommended method of configuring transparency on the SBC Core for new deployments as well as when 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> aiToPemInterworking <enable | disable>
Flags (a)
Parameter | Description |
---|---|
acceptAlertInfo | Enable flag for the 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.
NOTE: 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. NOTE: 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 SBC acting as P-CSCF or IBCF to add two Path headers in REGISTER request towards the Core (createPathHeader must be enabled) OR allow SBC acting as IBCF to add two Service-Route headers in 200 OK response for REGISTER towards the P-CSCF (createServiceRouteHeader must be enabled).
NOTE: When |
aiToPemInterworking | This flag is used to interwork between PEM and AI headers and the other way. This flag is configured on the IP Signaling Profile. The options are:
If disabled, the SBC plays tone based on the LMSD format. If enabled, the SBC plays tone based on the interworking between the AI to PEM or PEM to AI headers. For details, refer to Signaling - Alert-Info to P-Early Media Interworking - CLI |
% 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>
Flags {c}
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.
NOTE: This flag is configurable from an 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 SBC 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.
NOTE: When |
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>
Flags {d}
Parameter | Description |
---|---|
disableAlsoHeader | Enable this flag to allow SBC to ignore the Also header if received from the remote peer and SBC does not send the Also header to the remote peer. When disabled, the SBC 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 SBC 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 SBC disables media lock-down by not informing the egress peer using a re-INVITE. If the SBC offers both pass-through and transcoding codecs, the If this flag is disabled, the SBC 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 SBC uses the cause code in the received Reason header.
|
doNotIncludeSsAttributeInReInvite | Enable flag to prevent SBC 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 SBC sends a=silenceSupp:off in the SDP to the remote peer.
NOTE: 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>
Flags {e}
Parameter | Description |
---|---|
enableDefaultPUIProcedures | Enable this flag to allow default PUI procedures on egress trunk group. Note that the Privacy 'Transparency' flag must be disabled to allow this feature.
|
enableDialStringHandling | This flag is primarily used to enable/disable transparency of dial string (i.e username) received in request URI of INVITE message. Transparency does not occur, however, if PSX/ERE returns globalized or non-private called address. SBC performs dial string identification based on RFC 4967.
|
endToEndBye | For SIP-to-SIP calls, enable flag to prevent SBC from issuing the 200 BYE on the side initiating the disconnect until the 200 BYE is received from the other leg. When disabled, the SBC issues the 200 BYE on the side initiating the disconnect regardless of whether a 200 BYE is received from the other leg.
|
| When this flag is enabled, SBC forwards the received reliable provisional response without generating PRACK locally. It waits for the PRACK from ingress peer to generate PRACK towards egress peer.
NOTE: This flag must be enabled when both endpoints support PRACK and the 100rel header extension. |
endToEndReInvite | When this flag is enabled, SBC forwards the Re-INVITEs received from one leg (with or without SDP) to the other leg.
|
endToEndUpdate | When this flag is enabled, SBC forwards the Update (With SDP) received from one leg to the other leg.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags fromHeaderAnonymisation <disable | enable>
Flags {f}
Parameter | Description |
---|---|
| Enable this flag to prevent the FROM header of
|
% 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>
Flags {i}
Parameter | Description |
---|---|
includeIpPortsInFromAndToHeaders | When enabled, port numbers are included with IP addresses in the From and To headers of SIP messages. When disabled, port numbers are not included with IP addresses.
|
includeReasonHeader | When enabled, the SBC includes the Reason header in 18x, 4xx, 5xx, Cancel, and Bye messages in the forward direction. It is provisioned on the egress trunk group.
|
includeSsAttributeInInitialInvite | Enable this flag to send the 'a=silenceSupp:off' in the Initial Invite SDP to the remote peer when Silence Suppression is OFF. When disabled, 'a=silenceSupp' is not sent in the Initial Invite SDP to the remote peer. Note that 'a=silenceSupp:on' is never sent to the remote peer in the Ribbon implementation when Silence Suppression is ON.
|
includeTransportTypeInContactHeader | This flag is used by an SBC configured for an external PSX. When this flag is enabled, the SBC includes the Transport Type parameter in the Contact headers of 3XX responses. The PSX sends the value of this flag in a DIAMETER response to the SBC. When this flag is disabled, the SBC does not include the Transport Type parameter.
NOTE: Ensure passcompletecontactHeader flag is disabled (except for the REGISTER method) to obtain the desired behavior. |
insertPAccessNetworkInfo | Enable flag to construct and send PANI with received location info.
|
insertPeerAddressAsTopRouteHeader | When enabled, the SBC SIPE inserts the IP address of the next hop in the top route header of the egress INVITE. This is required when the SBC acts as a IMS BGCF proxy, and also supports SIPconnect compliance for direct inward dialing.
|
insertUEFlowInfo | Enable flag to send P-UE-Flow-Info header towards core.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags lockDownPreferredCodec <disable | enable>
Flags {l}
Parameter | Description |
---|---|
lockDownPreferredCodec | 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.
NOTE: This flag must be enabled in conjunction with NOTE: 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>
Flags {m}
Parameter | Description |
---|---|
mapCauseLocation | Enable this flag to add the cause location is added to or retrieved from the SIP Reason header when mapping ISUP-to-SIP or SIP-to-ISUP signaling (you must also enable the Include Reason Header function). ISUP (and other protocols) indicate where in the network a call release was initiated from; this option enables the SIP Reason header to carry the cause location as well as the cause value. When flag is disabled, cause location mapping is off.
|
mapSuspendResumeEventInPSvcInfoHeader | Enable this flag to map the suspend/resume event in the P-Svc-Info header. When disabled, the SBC does not map the suspend/resume event in the P-Svc-Info header.
|
mapUuiInPSigInfoHeader | Enable this flag to map the UUI parameter into the SIP P-Sig-Info header. When disabled, the SBC does not map or include the UUI parameter.
|
mimeCausePrecedeReasonHeaderCause | When enabled, the cause value is mapped from the MIME body of the incoming message based on the Q.1912 standard. When disabled, the cause value is mapped from the Reason header based on the RFC3398 standard
|
minimizeRelayingOfMediaChangesFromOtherCallLegAll | The advertised Ribbon SIP SDP is described as a set of capabilities that the SBC can receive. The SBC by default issues a Modify Offer ( re-INVITE, UPDATE) whenever it detects a change in receive capabilities. In certain scenarios, the Modify Offer can be perceived as redundant. Enabling this flag suppresses redundant Modify offers being sent from the SBC. When enabled, the SBC suppresses modify offers that have no changes to the “common codecs” that impact the end-user experience. “Common codecs” are codecs that exist both in the initial offer and answer. Changes to common codecs imply changes to DTMF, packetization time, codec specific FMTP attributes and data-path-mode.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags noContentDisposition <disable | enable> noPortNumber5060 <disable | enable> noServiceRouteHdrForEmergencyRegistration <disable | enable> noUserinfoInContactHeader <disable | enable>
Flags {n}
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, SBC 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 SBC does not receive a port number in Record-Route headers, the SBC 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 SBC inserts port number 5060 into the outgoing Record-Route and Route headers.
NOTE: Enable this flag to allow DNS NAPTR/SRV lookups. |
| When this flag is enabled, SBC does not add Service-Route headers for emergency registrations even if
|
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>
Flags {o}
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.
NOTE: 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>
Flags {p}
Parameter | Description |
---|---|
pCalledPartyIDSupport | Enable flag to allow SBC acting as P-CSCF to store pCalledPartyID header when a call destined to UE is received from IMS core network. SBC inserts P-Asserted-Identity header in the 18x/2xx responses received from UE towards core and places the stored P-Called-Party-ID information in the PAI header.
|
pChgMsgInfo | When enabled, the SBC adds a P-ChgMsg header to a SIP INFO or a 183 Session Progress (which it selects depends on the call state). The P-ChgMsg header contains the interworked ISUP CHG with TLEC information. When disabled, this function is disabled.
|
| Enable flag to include the SBC's IP address in the SDP for hold.
|
% 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>
Flags {r}
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> suppressMinSeIfNotReceived <disable | enable>
Flags {s}
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 can be subjected to 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. |
| 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, 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
|
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>
Flags {t}
Parameter | Description |
---|---|
terminalPortabilityInterworking | Enable flag to provide a service between ISUP and SIP to move a terminal from one socket to another, or to move a call from one terminal to another while the call is active.
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags usePsxRouteforRegisteredInvite <disable | enable>
Flags {u}
Parameter | Description |
---|---|
usePsxRouteforRegisteredInvite | Enable flag to route
|
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags validateAccessNwInfoHeader <disable | enable>
Flags {v}
Parameter | Description |
---|---|
| Enable flag to prevent forwarding P-Access-Network-Info header when network-provided parameter is present. This flag is associated with Egress TG with respect to Request and Response message (Core Side).
NOTE: This is applicable for both INVITE and non-INVITE message and their responses. |