Versions Compared

Old Version 6

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 7

changes.mady.by.user Ribbon Communications

Saved on

Key

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

 

Anchor
top
top

...

section

Panel
borderColorgreen
bgColortransparent
borderWidth2
Noprint

Back to Table of Contents

Back to CLI Configure Mode

Back to Profiles - CLI

Back to Signaling - CLI

Back to IP Signaling Profile - CLI

Back to IP Signaling Profile - SIP - CLI

Additional sections:

column

Children Display

Panel

In this section:

Table of Contents
maxLevel3

styleh6

 

This section lists CLI commands to configure common IP attributes for communicating with the peer regardless of call direction.

High Level Syntax

Code Block
titlecommonIpAttributes High Level Syntax
% set profiles signaling ipSignalingProfile DEFAULT_SIP commonIpAttributes
	callTransferFlags
	flags
	headerEncryptionFlags
	optionTagInRequireHeader
	optionTagInSupportedHeader
	relayFlags
	subscriptionPackageSupport
	transparencyFlags 

Call Transfer Flags

Command Syntax

Code Block
languagenone
titlecommonIpAttributes callTransferFlags
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes callTransferFlags 
	forceReRouteViaPsxQuery <disable | enable> 
	handleIpAddressesNotPresentInNetworkSelectorTableNst <rejectCall | routeViaDefaultZoneIptg | routeViaDefaultiptg | routeViaTransferringIptg>

Command Parameters

...

classpdf6pttext

...

0Table
1Call Transfer Flags
3Call Transfer Flags

...

Parameter

...

Description

...

Enable this flag to allow 

Spacevars
0product
to perform a PSX query for new routes instead of using the IP address received in the Refer-To header.

...

disabled (default) – When this flag is disabled, the 

Spacevars
0product
does one of following:

  • If the IP address in the Refer-To header is zero or matches the 
    Spacevars
    0product
    signaling IP address, the 
    Spacevars
    0product
    performs a PSX query for new routes.
  • If IP address in Refer-To header does not match 
    Spacevars
    0product
    signaling IP address and it is present in 
    Spacevars
    0product
    Network Selector table, the 
    Spacevars
    0product
    sends an INVITE message to the IPTG selected from the Network Selector table.
  • If IP address in the Refer-To header does not match 
    Spacevars
    0product
    signaling IP address and is not present in the 
    Spacevars
    0product
    Network Selector table, 
    Spacevars
    0product
    handles the transfer via the Handle IP Addresses Not Present In Network Selector Table NST field (see below).

...

Spacevars
0product

...

regardless of

...

handleIpAddressesNotPresentInNetworkSelectorTableNst

...

 

...

Spacevars
0product

...

  • rejectCall – The 
    Spacevars
    0product
    always rejects the call transfer.
  • routeViaDefaultZoneIptg – The 
    Spacevars
    0product
    sends the call transfer INVITE out from the Default Zone's IPTG.
  • routeViaDefaultiptg – This option is not applicable at this time.
  • routeViaTransferringIptg (default) – The 
    Spacevars
    0product
    sends the call transfer INVITE back out the transferring IPTG (i.e. the IPTG on which the REFER request arrived).
Noprint

Back to Top

Flags

Command Syntax

Code Block
languagenone
titlecommonIpAttributes flags
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes flags 
	addPChargingFuncAddr <disable | enable> 
	addPathServiceRoute <disable | enable> 
	callHoldInterworking <disable | enable> 
	clearmodeForDataCalls <disable | enable>
	contactTransparencyForIsFocusMediaTag <disable | enable>
	createPChargingVector <disable | enable>
	createPVisitedNetworkId <disable | enable> 
	createPathHeader <disable | enable> 
	createServiceRouteHeader <disable | enable> 
	customizedSessionTimerBehavior <disable | enable> 
	disableAlsoHeader <disable | enable> 
	disableHostTranslation <disable | enable> 
	disableMediaLockDown <disable | enable> 
	disableReferToUriParameters <disable | enable> 
	discardReceivedReasonHeader <disable | enable> 
	doNotIncludeSsAttributeInReInvite <disable | enable> 
	enableDefaultPUIProcedures <disable | enable> 
	enableDialStringHandling <disable | enable> 
	endToEndBye <disable | enable>
	fromHeaderAnonymisation <disable | enable>
	includeIpPortsInFromAndToHeaders <disable | enable> 
	includeReasonHeader <disable | enable> 
	includeSsAttributeInInitialInvite <disable | enable> 
	includeTransportTypeInContactHeader <disable | enable>
	insertPAccessNetworkInfo <disable | enable>
	insertPeerAddressAsTopRouteHeader <disable | enable>
	insertUEFlowInfo <disable | enable>
	lockDownPreferredCodec <disable | enable>
	mapCauseLocation <disable | enable> 
	mapSuspendResumeEventInPSvcInfoHeader <disable | enable> 
	mapUuiInPSigInfoHeader <disable | enable> 
	mimeCausePrecedeReasonHeaderCause <disable | enable> 
	minimizeRelayingOfMediaChangesFromOtherCallLegAll <disable | enable> 
	noContentDisposition <disable | enable> 
	noPortNumber5060 <disable | enable>
	noServiceRouteHdrForEmergencyRegistration <disable | enable>
	noUserinfoInContactHeader <disable | enable> 
	onlySelectedCodecInSessionRefresh <disable | enable> 
	pCalledPartyIDSupport <disable | enable> 
	pChgMsgInfo <disable | enable> 
	publishIPInHoldSDP <disable | enable> 
	reQueryPsxOnRegisterRefresh <disable | enable> 
	rejectRefer <disable | enable>
	relayDataPathModeChangeFromOtherCallLeg <disable | enable>
	replaceHostOnViaHeader <disable | enable> 
	restrictHistoryInfoHeader <disable | enable> 
	routeUsingRecvdFqdn <disable | enable>
	sdpOlineOnlyCompares <disable | enable> 
	sendAllAllowedCodecsForLateMediaInviteOrReInvite <disable | enable> 
	sendDirectMediaInfoInSdpAttribute <disable | enable> 
	sendOnlyPreferredCodec <disable | enable>
	sendPtimeInSdp <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>
	terminalPortabilityInterworking <disable | enable>
	usePsxRouteforRegisteredInvite <disable | enable>
	validateAccessNwInfoHeader <disable | enable>
Noprint

Back to Top

Command Parameters

...

classpdf6pttext

...

0Table
1Flags
3Flags

...

Parameter

...

Description

...

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.

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.

  • disable (default)
  • enable
Info

 When using PSX in your network, enable the acceptAlertInfo flag from PSX's IP Signaling Profile.

...

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

...

Spacevars
0product

...

Spacevars
0product

...

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

...

call

...

  • disable (default)
  • enable

...

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

...

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 ePSX or external PSX.

...

direction

...

. The

...

  • disable (default)
  • enable

high-level Common IP Attributes syntax is shown below.

 

Code Block

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

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

...

  • disable  (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable  (default)
  • enable

...

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

...

  • disable  (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)

  • enable

Note

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

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

fromHeaderAnonymisation

...

Enable this flag to prevent the FROM header of INVITE message from being anonymized. The SBC always relays the FROM header of INVITE.

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

When

Spacevars
0product
is configured for PSX/ePSX, 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 includes the Transport Type parameter in the Contact headers of 3XX responses. When disabled, the PSX SIPE does not include the Transport Type parameter.

When

Spacevars
0product
is configured for ERE, 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 messages when the selected transport is not UDP.

  • disable (default)
  • enable

...

Enable flag to construct and send PANI with received location info.

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

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

  • disable (default)
  • enable

...

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.

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

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable  (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

The advertised Sonus SIP SDP is described as a set of capabilities that the

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

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 (G711U in commonIpAttributes - SIP - CLI). Changes to common codecs imply changes to DTMF, packetization time, codec specific FMTP attributes and data-path-mode.

  • disable (default)
  • enable

...

  • disable  (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

Spacevars
0product

...

Spacevars
0product

...

  • 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

...

  • disable (default)
  • enable

...

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

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

The o-line of the SDP will be identical to that in the last offer.

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

publishIPInHoldSDP

...

Enable flag to include the SBC's IP address in the SDP  for hold.

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

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

...

Note
The relayDataPathModeChangeFromOtherCallLeg flag is only available when minimizeRelayingOfMediaChangesFromOtherCallLegAll is enabled.

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

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Info

See SDP Support for examples of the above behavior.

Configuration options:

  • disable (default)
  • enable

...

  • disable (default)

  • enable

Note

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

...

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

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)

  • enable

Note

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

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • 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=-).

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

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

Example of SBC acting as IBCF:
           INVITE (PCV1) --> SBC --> INVITE
           200 OK (PCV1) <-- SBC <-- 200 OK

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

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

...

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

...

  • disable (default)

  • enable

...

Enable flag to route INVITE from the core to the received PSX route for registered users, but not to the contact address of the RCB.

  • disable (default)
  • enable

...

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

  • disable (default)

  • enable

Note

This is applicable for both INVITE and non-INVITE message and their responses.

Noprint

Back to Top

Header Encryption Flags

Command Syntax

Code Block
languagenone
titlecommonIpAttributes headerEncryptionFlags
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes headerEncryptionFlags
	encryptPathHeader <disable | enable>
	encryptServiceRouteHeader <disable | enable>

Command Parameters

Caption
0Table
1Header Encrpytion Flags
3Header Encrpytion Flags

Parameter

Description

encryptPathHeader

If enabled, the SBC encrypts path headers in Register Request and

Register response messages.

  • disabled (default)
  • enabled
encryptSeviceRouteHeader

If enabled, the SBC encrypts Service-route headers in Register response messages.

  • disabled (default)
  • enabled
Noprint

Back to Top

Option Tag In Require Header

Command Syntax

Code Block
languagenone
titlecommonIpAttributes optionTagInRequireHeader
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes optionTagInRequireHeader suppressReplaceTag <disable | enable>

Command Parameters

Div
classpdf6pttext
Caption
0Table
1Option Tag in Require Header
3Option Tag in Require Header

Parameter

Length/Range

Description

optionTagInRequireHeader

N/A

Use this control to suppress REPLACE tag in the Require header.
If the Replaces header is present in a received SIP REFER request, the 

Spacevars
0product
includes the contents of the Replaces header (callID, From Tag and To Tag) in the outgoing INVITE without a full ERE query. This enables one 
Spacevars
0product
to transfer two independent calls and connect them together using IP trunk group (IPTG) routing. IPTG routing must be enabled for this feature.

  • suppressReplaceTag – Controls the content in Require headers to be sent to the peer. When enabled, the REPLACE tag is suppressed in the Require header. If disabled, the REPLACE tag is included in the Require header.
    • disable (default)
    • enable
Noprint

Back to Top

Option Tag In Supported Header

Command Syntax

Code Block
languagenone
titlecommonIpAttributes optionTagInSupportedHeader
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes optionTagInSupportedHeader <optionTagInSupportedHeader> suppressReplaceTag <disable | enable>

Command Parameters

Div
classpdf6pttext
Caption
0Table
1Option Tag in Supported Header
3Option Tag in Supported Header

Parameter

Length/Range

Description

optionTagInSupportedHeader

N/A

Use this control to suppress the REPLACE tag in the Supported header.
If the Replaces header is present in a received SIP REFER request, the 

Spacevars
0product
includes the contents of the Supported header (call ID, From Tag and To Tag) in the outgoing INVITE, OPTIONS, and INVITE/OPTIONS without a full ERE query. This enables one 
Spacevars
0product
to transfer two independent calls and connect them together using IP trunk group (IPTG) routing. IPTG routing must be enabled for this feature. This control suppresses this feature.

  • suppressReplaceTag – Controls the content in Supported headers to be sent to the peer. When enabled, the REPLACE tag is suppressed in the Supported header. If disabled, the REPLACE tag is included in the Supported header.
    • disable (default)
    • enable
Noprint

Back to Top

Registrar Recovery

Use this configuration to control how SBC handles a primary SIP server failure. SBC is capable of registering to the alternate SIP server immediately when primary SIP server goes down, and will revert back to primary SIP server when is back up. The status of the servers is detected through Address Reachability Service (ARS) blacklist. For every switch from primary to secondary/alternate or from secondary/alternate to primary, the SBC queries the ERE/PSX to obtain the latest routing information and route refresh REGISTERs.

See request addressContext for details of the command to query PSX on new refresh REGISTERs.

Note
iconfalse
titlequeryPsxOnNextRefreshRegister conditions:
  • This feature requires Pathcheck support using OPTIONS Ping and ARS static blacklisting to detect the reachability of a particular IP/FQDN.
  • If both request command and IPSP flags are configured, the request command takes precedence over IPSP flags.

Command Syntax

Code Block
languagenone
titlecommonIpAttributes registrarRecovery
% set profiles signaling ipSignalingProfile DEFAULT_SIP commonIpAttributes registrarRecovery
	deRegisterAlternateOnPrimaryRecovery <disable | enable>
	overrideInternalExpiresTimer <disable | enable>
	registerToAlternateOnPrimaryDown <disable | enable>
	revertToPrimaryOnRecovery <disable | enable>

Command Parameters

...

0Table
1Register Recovery
3Register Recovery

...

Parameter

...

Description

...

Enable flag to allow SBC to de-register itself from the alternate SIP server when the connection with primary SIP server is established.

  • disable (default)
  • enable
Note

The flag revertToPrimaryOnRecovery must be enabled to use this flag.

...

overrideInternalExpiresTimer

Enable flag to override the internal expires timer for registration and forward refresh REGISTER to available SIP server.

When disabled, refresh REGISTER is answered locally by SBC until the internal Expires Timer expires.

  • disable (default)
  • enable
Note

The flag registerToAlternateOnPrimaryDown must be enabled to use this flag. The default value of the timer is 3600 seconds.

...

Enable the flag to allow SBC to send refresh REGISTER to alternate SIP server when Primary SIP server is down or unreachable.

  • disable (default)
  • enable

...

Enable flag to allow SBC to send refresh REGISTER to primary SIP server and reestablish the connection when primary SIP server is reachable.

  • disable (default)
  • enable
Note

The flag registerToAlternateOnPrimaryDown must be enabled to use this flag.

Noprint

Back to Top

Relay Flags

Note

For a list of SIP headers that cannot be controlled using relay flags in relay scenarios, see Relay Flags page.

Command Syntax

Code Block
languagenone
titlecommonIpAttributes relayFlags
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes relayFlags
	conferenceEventPackage <disable | enable>
	dialogEventPackage <disable | enable> 
	dtmfBody <disable | enable> 
	force503to500Relay <disable | enable> 
	info <disable | enable> message <disable | enable>
	messasge <disable | enable>
	notify <disable | enable> options <disable | enable> 
	options <disable | enable>
	publish <disable | enable> refer <disable | enable> 
	refer <disable | enable>
	referToHeaderRelay <disable | enable>
	regEventPackage <disable | enable> 
	sonusMediaBody <disable | enable> 
	statusCode3xx <disable | enable> 
	statusCode4xx6xx <disable | enable> 
	thirdPartyBodies <disable | enable>
	updateWithoutSdp <disable | enable>

Command Parameters

...

classpdf6pttext

...

0Table
1Relay Flags
3Relay Flags

...

Parameter

...

Length/Range

...

Description

...

  • disable (default)
  • enable
Note
To pass this body transparently, enable the conference-info xml body relay flag.

...

Spacevars
0product

...

  • disable (default)
  • enable
Note

This flag only applies to unregistered users.

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

referToHeaderRelay

...

Use this flag to relay the replaces in refer-To header of relayed REFER request. The options are:

  • rejectReferIfnoMatchForcallId (default) – If no match is found for the call-Id received, the REFER is rejected.
  • relayReferIfNoMatchForCallId – The SBC tries to match the received call-Id. If  a match is found, the SBC translates the replaces header and relays the REFER message. If no match is found for call-id, the SBC relays the replaces without any changes.
  • relayReferWithoutMatching – The SBC always relays the replaces in refer-to without searching for match of call-id.

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable
Note

You must enable this flag when using authcodeHeaders transparency flag.

...

  • disable (default)
  • enable

...

updateWithoutSdp

...

N/A

...

  • disable (default)
  • enable
Noprint

Back to Top

Subscription Package Support

Command Syntax

Code Block
languagenone
titlecommonIpAttributes subscriptionPackageSupport
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes subscriptionPackageSupport
	supportRegEvent <disable | enable>
 	usePSXRouteForSBCInitiatedSubscribe (NOT SUPPORTED)

Command Parameters

...

classpdf6pttext

...

0Table
1Subscription Package Support Flags

...

Parameter

...

Description

...

subscriptionPackageSupport

Use this object to configure subscription support package.

  • supportRegEvent – Enable flag to allow SBC to subscribe to reg-event package for obtaining updates on registration status when the registration from the user is successful.
    • disable (default)
    • enable
Note

The flag usePSXRouteForSBCInitiatedSubscribe is currently visible in CLI under subscriptionPackageSupport object as well, but it is not supported.

Noprint

Back to Top

Transparency Flags

Command Syntax

Code Block
languagenone
titlecommonIpAttributes transparencyFlags
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes transparencyFlags 
	acceptContactHeader <disable | enable> 
	acceptHeader <disable | enable> 
	acceptLanguageHeader <disable | enable>
	alertInformationHeader <disable | enable> 
	authcodeHeaders <disable | enable> 
	callInfoHeader <disable | enable> 
	contactHeader <disable | enable> 
	errorInfo <disable | enable> 
	externalBody <disable | enable>
	fromHeader <disable | enable> 
	geolocation <disable | enable> 
	geolocationError <disable | enable> 
	geolocationRouting <disable | enable> 
	historyInfo <disable | enable> 
	maxForwardsHeader <disable | enable> 
	messageExternalBody <disable | enable>
	mwiBody <disable | enable> 
	pAccessNetworkInfoHeader <disable | enable> 
	pCalledPartyID <disable | enable> 
	pChargingVectorHeader <disable | enable> 
	pEarlyMedia <disable | enable> 
	pVisitedNetworkIDHeader <disable | enable> 
	passCompleteContactHeader <disable | enable> 
	pathHeader <disable | enable> 
	pidfBody <disable | enable>
	pidfDiffBody <disable | enable>
	qsigBody <disable | enable> 
	reasonHeader <disable | enable> 
	referredByHeader <disable | enable> 
	requestURI <disable | enable> 
	resourceListBody <disable | enable>
	resourcePriorityOptionTag <disable | enable>
	rlmiBody <disable | enable>
	routeHeader <disable | enable> 
	serverHeader <disable | enable>
	serviceRouteHeader <disable | enable> 
	simpleFilterBody <disable | enable>
	sipBody <disable | enable> 
	sipfragBody <disable | enable> 
	toHeader <disable | enable> 
	toneBody <disable | enable> 
	unknownBody <disable | enable> 
	unknownHeader <disable | enable> 
	userAgentHeader <disable | enable>
	userToUserHeader <disable | enable> 
	viaHeader <disable | enable>
	warningHeader <disable | enable>
	watcherInfoBody <disable | enable>
Noprint

Back to Top

Command Parameters

Note

For a list of SIP headers that cannot be controlled using transparency flags in relay scenarios, see IPSP Transparency Flags.

...

classpdf6pttext

...

0Table
1Transparency Flags
3Transparency Flags

...

Parameter

...

Length/Range

...

Description

...

  • disable (default)
  • enable

...

  • disable (default) – Accept header includes: application/sdp, application/isup, application/dtmf, application/dtmf-relay, multipart/mixed information.
  • enable – Accept header is transparently passed from ingress to egress.

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable
Note

You must enable statusCode4xx6xx relay flag when using authcodeHeaders transparency.

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)

  • enable

Note

Even when this flag is enabled, the IP port information is not included unless the "Include IP Ports in From and To Headers" flag, elsewhere in this IP Signaling Profile, is also enabled.

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default) –
    Spacevars
    0product
    suppresses the PANI header towards egress messages when the incoming message contains PANI header.

  • enable – 

    Spacevars
    0product
    transparently passes PANI header from ingress to egress.

Note

Enable this flag when 

Spacevars
0product
is configured as P-CSCF node.

...

pCalledPartyID

...

  • disable (default)
  • enable

...

Spacevars
0product

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Spacevars
0product

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

Enable flag to transparently copy the userinfo@host component of the TO header from the ingress SIP INVITE message to the egress SIP INVITE message. When flag is disabled, SBC generates its own TO header.

  • disable (default)
  • enable
Note

Even when this flag is enabled, the IP port information is not included unless the "Include IP Ports in From and To Headers" flag, elsewhere in this IP Signaling Profile, is also enabled.

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable

...

  • disable – (default) Default behavior where IP address on the VIA header is the local SIP signaling address.
  • enable – Transparently pass all the VIA headers received in original INVITE or REGISTER. With only the transparency flag enabled,  the SBC will still include the local SIP signaling address and port as the top most VIA header.

...

  • disable (default)
  • enable

...

  • disable (default)
  • enable
Noprint

Back to Top

Command Example

From system-level prompt, use following command to view IP signaling profile flags for DEFAULT_SIP profile in table format.

Code Block
languagenone
 > show table profiles signaling ipSignalingProfile DEFAULT_SIP egressIpAttributes flags 
bgcfTargetSchemeTransparency disable; 
convertInactiveToSendrecv disable; 
disable2806Compliance disable; 
disableOptionalRegisterParameters disable; 
map181Or182MessageTo183 disable; 
mapContractorNumberInPSigInfoHeader disable; 
suppressUnregister disable; 
ttcIsupMapping disable; 
useCalledPartyInRequestUri disable; 
useColonInSdpMediaTypeParameter disable; 
validateIsubAddress disable; 
qosBasedRouting disable;
Noprint

Back to Top

...

Noprint
Back to Top

	callTransferFlags
	flags
	headerEncryptionFlags
	optionTagInRequireHeader
	optionTagInSupportedHeader
	registrarRecovery
	relayFlags
	subscriptionPackageSupport
	transparencyFlags

 

Pagebreak