Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Command Parameters

Caption
0Table
1Flags (a)

 

ParameterDescription
acceptAlertInfo

Enable flag for

...

the

Spacevars
0product
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.

  • disable (default)
  • enable

...

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

...

Spacevars
0product
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 acceptAlertInfo flag from PSX's IP Signaling Profile. \

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.

  • disable (default)
  • enable
addPathServiceRouteEnable this flag to allow 
Spacevars
0product
acting as P-CSCF or IBCF to add two Path headers in REGISTER request towards the Core (createPathHeader must be enabled) OR allow 
Spacevars
0product
acting as IBCF to add two Service-Route headers in 200 OK response for REGISTER towards the P-CSCF (createServiceRouteHeadermust be enabled).
  • disable (default)
  • enable

...

NOTE: When noServiceRouteHdrForEmergencyRegistration flag is enabled,

Spacevars
0product
does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled.

 

c

Command Syntax

Code Block
titlecommonIpAttributes flags {c}
% 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> 

Command Parameters

Caption
0Table
1Flags {c}

 

ParameterDescription
callHoldInterworkingSet 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.
  • disable (default)
  • enable
clearmodeForDataCallsSet flag to enable the clearmode function for data calls.
  • disable – (default) If disabled for the SIP Egress call leg, legacy operation is signaled and payload type is assumed implicit (same on both sides). If disabled for the SIP Ingress call leg, legacy G.711 operation is accepted as well as Clearmode.
  • enable – If enabled for the SIP Egress call leg, Clearmode is sent using dynamic payload type. If enabled for SIP Ingress call leg, only Clearmode data calls are accepted.
contactTransparencyForIsFocusMediaTag

Enable flag to transparently pass Contact header for all requests and responses in outgoing message when "isFocus" parameter is received in Contact header.

  • disable (default)

  • enable

...

NOTE: This flag is configurable from an external PSX.

createPChargingVectorEnable 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.
  • disable (default)
  • enable
createPVisitedNetworkIdEnable flag to allow 
Spacevars
0product
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.
  • disable (default)
  • enable
createPathHeaderEnable flag to create a new Path header in the outgoing REGISTER request.
  • disable (default)
  • enable
createServiceRouteHeaderEnable flag to create a new Service-Route header in the outgoing 200 OK response for REGISTER.
  • disable  (default)
  • enable

...

NOTE: When noServiceRouteHdrForEmergencyRegistration flag is enabled,

Spacevars
0product
does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled.

customizedSessionTimerBehaviorWhen enabled, the remote peer expects customer-specific session timer behavior. When disabled, the remote peer expects the standard session timer behavior.
  • disable  (default)
  • enable
 

d

Command Syntax

Code Block
titlecommonIpAttributes flags {d}
% 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> 

Command Parameters

Caption
0Table
1Flags {d}

 

ParameterDescription
disableAlsoHeaderEnable this flag to allow 
Spacevars
0product
to ignore the Also header if received from the remote peer and 
Spacevars
0product
does not send the Also header to the remote peer. When disabled, the 
Spacevars
0product
uses the Also header for call forwarding as usual.
  • disable (default)
  • enable
disableHostTranslationUse 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.
  • disable  (default)
  • enable
disableMediaLockDown

Enable this flag to allow 

Spacevars
0product
to disable media lock-down by not sending SIP Re-INVITE/UPDATE messages in the following scenarios:

  • Multiple codecs are sent in the offer and multiple codecs (or their subsets) are received in the answer, and the call becomes transcoded.
  • Multiple codecs are sent in the offer and a single codec is received in the response.
  • Multiple codecs are sent in the offer and a single codec with codec attributes is received in the response.

 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

Spacevars
0product
disables media lock-down by not informing the egress peer using a re-INVITE.

If the

Spacevars
0product
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
Spacevars
0product
’s most preferred codec matches the peer's most preferred codec, enable the disableMediaLockDown flag to suppress this Modify Offer initiated by the
Spacevars
0product
to lock down the codec.

If this flag is disabled, the 

Spacevars
0product
sends a modify offer to lock down the codec.

  • disable  (default)
  • enable
disableReferToUriParametersBy 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.
  • disable  (default)
  • enable
discardReceivedReasonHeader Enable flag to ignore cause code in received Reason header. When disabled, the 
Spacevars
0product
uses the cause code in the received Reason header.
  • disable (default)
  • enable
doNotIncludeSsAttributeInReInviteEnable flag to prevent 
Spacevars
0product
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 
Spacevars
0product
sends a=silenceSupp:off in the SDP to the remote peer.
  • disable (default)
  • enable

...

NOTE: a=silenceSupp:on is never sent to remote peer in current implementation when silence suppression is on.

 

e

Command Syntax

Code Block
titlecommonIpAttributes flags {e}
% 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>

Command Parameters

Caption
0Table
1Flags {e}

 

ParameterDescription
enableDefaultPUIProceduresEnable this flag to allow default PUI procedures on egress trunk group. Note that the Privacy 'Transparency' flag must be disabled to allow this feature.
  • disable (default)
  • enable
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.
  • disable (default)
  • enable
endToEndBye For SIP-to-SIP calls, enable flag to prevent 
Spacevars
0product
from issuing the 200 BYE on the side initiating the disconnect until the 200 BYE is received from the other leg. When disabled, the 
Spacevars
0product
issues the 200 BYE on the side initiating the disconnect regardless of whether a 200 BYE is received from the other leg.
  • disable (default)
  • enable

endToEndPrack

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.

  • disable (default)
  • enable

...

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.

  • disable (default)
  • enable
endToEndUpdate

When this flag is enabled, SBC forwards the Update (With SDP) received from one leg to the other leg.

  • disable (default)
  • enable
 

f

Command Syntax

Code Block
titlecommonIpAttributes flags {f}
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags 
	fromHeaderAnonymisation <disable | enable>

...

Caption
0Table
1Flags {i}
ParameterDescription
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.
  • disable (default)
  • enable
includeReasonHeader When enabled, the 
Spacevars
0product
includes the Reason header in 18x, 4xx, 5xx, Cancel, and Bye messages in the forward direction. It is provisioned on the egress trunk group.
  • disable (default)
  • enable
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 Sonus implementation when Silence Suppression is ON.
  • disable (default)
  • enable
includeTransportTypeInContactHeader

This flag is used by an When

Spacevars
0product
is configured for ERE or an external PSX.

The

Spacevars
0product
uses , this flag is used by the PSX SIPE to control inclusion/exclusion of the Transport Type parameter in the Contact headers of 3XX responses. When enabled, the PSX SIPE
Spacevars
0product
includes the Transport Type parameter in the Contact headers of 3XX responses. When disabled, the PSX SIPE
Spacevars
0product
does not include the Transport Type parameter when the selected transport is not UDP.

The When

Spacevars
0product
is configured for ERE, uses this flag is used by the
Spacevars
0product
to control inclusion/exclusion of the Transport Type parameter in the Contact headers of SIP requests and backward 2xx response messages when the selected transport is not UDP.

  • disable (default)
  • enable

UDP.

  • disable (default)
  • enable

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.

  • disable (default)
  • enable
insertPeerAddressAsTopRouteHeaderWhen enabled, the 
Spacevars
0product
SIPE inserts the IP address of the next hop in the top route header of the egress INVITE. This is required when the 
Spacevars
0product
acts as a IMS BGCF proxy, and also supports SIPconnect compliance for direct inward dialing.
  • disable (default)
  • enable
insertUEFlowInfo

 Enable flag to send P-UE-Flow-Info header towards core.

  • disable (default)
  • enable
 

...

Command Parameters

Caption
0Table
1Flags {l}

 

ParameterDescription
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.

  • disable (default)
  • enable

...

NOTE: This flag must be enabled in conjunction with minimizeRelayingOfMediaChangesFromOtherCallLegAll flag to produce desired results.

...

NOTE: When this flag is enabled, the flag “relayDataPathModeChangeFromOtherCallLeg” must also be enabled to propagate HOLD Modify Offers (any modify offer that changes the data-path-mode).

 

m

Command Syntax

Code Block
titlecommonIpAttributes flags {m}
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags 
	mapCauseLocation <disable | enable> 
	mapSuspendResumeEventInPSvcInfoHeader <disable | enable> 
	mapUuiInPSigInfoHeader <disable | enable> 
	mimeCausePrecedeReasonHeaderCause <disable | enable> 
	minimizeRelayingOfMediaChangesFromOtherCallLegAll <disable | enable>

...

Command Parameters

 
Caption
0Table
1Flags {n}
ParameterDescription
noContentDispositionThe 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.
  • disable  (default)
  • enable
noPortNumber5060Use 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, 
Spacevars
0product
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 
Spacevars
0product
does not receive a port number in Record-Route headers, the 
Spacevars
0product
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 
Spacevars
0product
inserts port number 5060 into the outgoing Record-Route and Route headers.
  • disable (default)
  • enable 

...

NOTE: Enable this flag to allow DNS NAPTR/SRV lookups.

noServiceRouteHdrForEmergencyRegistration

When this flag is enabled,

Spacevars
0product
does not add Service-Route headers for emergency registrations even if addPathServiceRoute and createServiceRouteHeader flags are enabled.

  • disable (default)
  • enable

noUserinfoInContactHeaderWhen 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.
  • disable (default)
  • enable
 

o

Command Syntax

Code Block
titlecommonIpAttributes flags {o}
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags 
	onlySelectedCodecInSessionRefresh <disable | enable> 

Command Parameters

 
Caption
0Table
1Flags {o}
ParameterDescription
onlySelectedCodecInSessionRefreshWhen 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.
  • disable (default)
  • enable

...

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:

  • disable: SBC sends keep-alive reINVITE with both Codec-A and Codec-B included
  • enable: SBC sends keep-alive reINVITE including Codec-B

...

Div
classpdf8pttext

NOTE: The relayDataPathModeChangeFromOtherCallLeg flag is only available when minimizeRelayingOfMediaChangesFromOtherCallLegAll is enabled.

ParameterDescription
reQueryPsxOnRegisterRefreshWhen enabled, the 
Spacevars
0product
will re-query the 
Spacevars
0product
when it receives a register refresh message, which may result in a new or updated result for the register relay. When disabled, the 
Spacevars
0product
does not re-query the 
Spacevars
0product
on a register refresh. This setting must be made on the ingress trunk group profile facing the registered endpoint.
  • disable (default)
  • enable
rejectReferWhen enabled, the 
Spacevars
0product
rejects SIP REFER messages from the peer and responds with a 405 Method Not Allowed message.
  • disable (default)
  • enable
replaceHostOnViaHeaderUse 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.
  • disable (default) – SBC defaults to B2BUA behavior where the VIA header contains local SIP signaling address.
  • enable Replaces the IP address of via header on the initial outbound INVITE or REGISTER with the address received in the via header of the incoming request.
relayDataPathModeChangeFromOtherCallLeg

When this flag is enabled in conjunction with minimizeRelayingOfMediaChangesFromOtherCallLegAll flag,the HOLD modify offers (more specifically, any modify offer that changes the data-path-mode) are propagated.

  • disable (default)
  • enable
Note
restrictHistoryInfoHeaderEnable this flag to restrict History InfoHeader Flag depending upon the Privacy header or Privacy URI.
  • disable (default)
  • enable
routeUsingRecvdFqdnEnable flag to use the FQDN received in contact header of Refer-To/3xx for routing.
  • disable (default)
  • enable

...

Div
classpdf8pttext

Configuration options:

  • disable (default)
  • enable

NOTE: Refer to SDP Support for examples of the above behavior.

Configuration options:

  • disable (default)
  • enable

NOTE: The 'directMediaAllowed' flag must be disabled on the associated trunk group.

NOTE: This flag is only accessible when the flag "minimizeRelayingOfMediaChangesFromOtherCallLegAll"  is set to "enable".

Example of SBC acting as IBCF:

            INVITE (PCV1) --> SBC --> INVITE
           200 OK (PCV1) <-- SBC <-- 200 OK

ParameterDescription
sdpOlineOnlyComparesWhen enabled, the SBC checks only the o-line when comparing SDPs. When disabled, the SBC checks the entire SDP body when comparing SDPs.
  • disable (default)
  • enable
sendAllAllowedCodecsForLateMediaInviteOrReInvite

Excerpt Include
SDP Support
SDP Support
nopaneltrue

Info
sendDirectMediaInfoInSdpAttributeEnable flag to send direct media information in the SDP attribute X-DMI.
  • disable (default)

  • enable

Note

sendOnlyPreferredCodec  

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.

  • disable (default)
  • enable
sendPtimeInSdpEnable flag to allow the SBC to send a=ptime in the SDP.
  • disable (default)
  • enable

sendRTCPBandwidthInfo

Enable flag to send the RR and RS bandwidth information, as well as "b=RR:" and "b=RS:" in the SDP offer.

  • disable (default)
  • enable
sendRtcpPortInSdpWhen enabled,  the
Spacevars
0product
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).
  • disable (default)
  • enable
sessionTimerRefreshUpdateEnable flag to control session timer refresh method with SIP peers via UPDATE messages. When disabled, the 
Spacevars
0product
sends INVITE messages.
  • disable (default)
  • enable

Note
setAcceptHeaderToApplicationSdpOnlyUse 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.
  • disable (default)
  • enable
setOlineDashSpecifies 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.
  • disable (default)
  • enable
setSessionVersionZeroEnable flag to set the session version to zero in the o-line of the outbound SDP. When disabled, the 
Spacevars
0product
assigns a session version randomly.
  • disable (default)
  • enable
setSlineDashSpecifies the SDP S-Line format in the SDP of SIP messages expected by the remote peer.
  • disable (default) – Remote peer receives standard S-Line format containing all of the S-Line parameters.
  • enable – Remote peer receives a short S-Line format containing a dash only (s=-).
skipPsxQueryForReferSet flag to skip the ERE query for Refer flag.
  • disable (default)
  • enable
storePChargingFuncAddrSet 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.
  • disable (default)
  • enable
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.

  • disable (default)
  • enable

Info
storePathHeaderSet this flag to locally store (cache) a Path header received in an incoming REGISTER request.
  • disable (default)
  • enable
storeServiceRouteHeaderSet this flag to locally store (cache) a Service-Route header received in an incoming 200 OK response to REGISTER.
  • disable (default)
  • enable
supportSCSCFRestorationProcedures

SBC acting as P-CSCF rejects a request with 504 (Server Time-out) response carrying MIME body of type application/3gpp-ims+xml, if SBC does not receive any response to the request from S-CSCF network or the next hop address is blacklisted as part of ARS (Address Reachability Service) service (see IMS Restoration Procedures for addtional details).

  • disable (default)
  • enable
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.

  • disable (default)
  • enable

...