Page History

...

Noprint

Panel

borderColor	green
bgColor	transparent
borderWidth	2

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

Back to commonIpAttributes - SIP - CLI

This section lists SIP Common IP Attributes Registrar Recovery parameter details.

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 Request Address Context - CLI for details of the command to query PSX on new refresh REGISTERs.

...

Parameter

Description

deRegisterAlternateOnPrimaryRecovery

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

icon	false
title	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

icon	false
title	Note

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

registerToAlternateOnPrimaryDown

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

revertToPrimaryOnRecovery

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.

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

language	none
title	commonIpAttributes 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

...

class	pdf6pttext

...

0	Table
1	Relay Flags
3	Relay Flags

...

Parameter

...

Description

...

disable (default)
enable

Note
To pass this body transparently, enable the `conference-info` xml body relay flag.

...

Spacevars

0	product

...

disable (default)
enable

Note
This flag only applies to unregistered users.

...

Spacevars

0	product

...

disable (default)
enable

...

disable (default)
enable

...

Spacevars

0	product

...

disable (default)
enable

...

Spacevars

0	product

...

disable (default)
enable

...

Spacevars

0	product

...

disable (default)
enable

...

Spacevars

0	product

...

disable (default)
enable

...

Spacevars

0	product

...

Spacevars

0	product

...

disable (default)
enable

...

Spacevars

0	product

...

Spacevars

0	product

...

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

0	product

...

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

...

disable (default)
enable

Noprint
Back to Top

Subscription Package Support

Command Syntax

Code Block

language	none
title	commonIpAttributes subscriptionPackageSupport

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

Command Parameters

...

class	pdf6pttext

...

0	Table
1	Subscription 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

language	none
title	commonIpAttributes 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.

...

class	pdf6pttext

...

0	Table
1	Transparency Flags
3	Transparency 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.

icon	false
title	Note

The flag registerToAlternateOnPrimaryDown must be enabled to use this flag.

...

disable (default)
enable

...

disable (default)
enable

...

disable (default)
enable

...

Spacevars

0	product

...

disable (default)
enable

...

disable (default)
enable

...

disable (default)
enable

...

disable (default)
enable

...

disable (default) –
Spacevars
0 product
suppresses the PANI header towards egress messages when the incoming message contains PANI header.
enable –
Spacevars
0 product
transparently passes PANI header from ingress to egress.

Note

Enable this flag when

Spacevars

0	product

is configured as P-CSCF node.

...

pCalledPartyID

...

disable (default)
enable

...

Spacevars

0	product

...

Spacevars

0	product

...

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

0	product

...

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

language	none

 > 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

...

Pagebreak

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Relay Flags

Command Syntax

Command Parameters

Subscription Package Support

Command Syntax

Command Parameters

Transparency Flags

Command Syntax

Command Parameters

Command Example