Page History

Anchor

	top
	top

Noprint

Panel

borderColor	green
bgColor	transparent
borderWidth	2

Back to Table of Contents

Back to CLI Configure Mode

Back to Address Context - CLI

Back to Zone - CLI

Back to zone sipTrunkGroup - CLI

Panel

In this section:

Table of Contents

maxLevel

...

3

Use this object to specify parameters controlling the specifics of SIP signaling for this SIP trunk group.

Note
As a best practice, always use UPPERCASE for trunk group names.

SIP Trunk Group Signaling

Command Syntax

Code Block

language	none

% set addressContext <name> zone <name> sipTrunkGroup <name> signaling
	E164Profiles
		e164GlobalProfile <global profile name>
		e164LocalProfile <local profile name>
	P-HeaderExtensions
		addEgressOrigCa <disabled | enabled>
		insertpVisitedNetworkID <identifier>
		useIngressOrigCa <disabled | enabled>
	TCPFallback 
		maxMTUSupportedOverUDPControl <disabled | enabled>
		maxMTUSupportedOverUDPValue <1-5000>
	X-Headers 
		HeaderFlag <none | xHeaders>
	acceptHistoryInfo <disabled | enabled>
	accessClass <3GPP | none>
	allowByeChallenge <disabled | enabled>
	authentication
	    authPassword <authentication password for trunkgroup> 
    	authUserPart <userPart used for authentication> 
	    intChallengeResponse <disabled | enabled> 
    	incInternalCredentials <disabled | enabled>
	backwardInfoMsgConDialog <disabled | enabled>
	callingParty 
		cpcParamFromHeader <default | fromheader | paitel>
		fromHdrForCallingParty <disabled | enabled>
		paiForCallingParty <disabled | enabled>
		ppiForCallingParty <disabled | enabled>
		rpiForCallingParty <disabled | enabled>
		trustedSourceForIsup <disabled | enabled>
	causeCodeMapping
		cpcSipCauseMappingProfile <profile name>
		sipCpcCauseMappingProfile <profile name>
		sipInternalCauseMappingProfile <profile name>
		useNonDefaultCauseCodeforARSBlackList <enabled | disabled>
	clearTcpConnectionsforRegistration <disabled | enabled>
	condIncMethInAllowHdr <disabled | enabled>
	deRegParentWithChildDereg <disabled | enabled>
	defaultCallingPartyNumber <default calling number>
	disableTermIOIForPcscf <disabled | enabled>
	egressCallIdStaticString <string>
	enforceSipsIfEgressIsTls <disabled | enabled>
	enforceTlsIfSipsUriScheme <disabled | enabled>
	factorValue <value>
	feidForPDCS <1-127>
	flexiblePolicyAdapterProfile <flexiblePolicyAdapterProfile name>
	honorMaddrParam <disabled | enabled>
	interOperatorID <identifier>
	isubParamPreference <nonstandard | rfc2806 | rfc3966>
	isupMimeBodyRelay <disabled | enabled>
	keepSupport <disabled | enabled>
	localNumberSupport <disabled | enabled>
	maxFwdsDefault <value>
	messageManipulation 
		includeAppHdrs <disabled | enabled>
		inputAdapterProfile <name>
		outputAdapterProfile <name>
	methods

...

ocsSupport

...

<disabled |

...

enabled>

...

outBoundSupport

...

<disabled |

...

enabled>
	postDialDelay

...

responseCode (400-699)

...

timeOut (0-20000)
	prefRequireTransparency <disabled |

...

enabled>

...

privacyParamRestricted

...

<default |

...

idonly>

...

psxRouteForSubscribe

...

<disabled |

...

enabled>

...

registration

...

rel100Support

...

<disabled |

...

enabled>

...

relayNonInviteRequest <disabled | enabled>

...

relayReplacesHeader <disabled | enabled>

...

relayUpdatewithSdp  <disabled | enabled>

...

retryCounters 
	rewriteIdentities <disabled | enabled>
	rfc3261ValidateCSeqInBYE <disabled | enabled>

...

rfc3261ValidateInvite200OkRetransmissions

...

<disabled |

...

enabled>

...

routeMsgValidation < noValidation | sipI |

...

sipOnly>

...

sdpTransparency

...

sdpTransparencyState <disabled | enabled>

...

skipDTGLookupForRouteHdr <disabled | enabled>

...

sendSdpToPsx <disabled |

...

enabled>

...

silenceSuppTreatment <treatAsFaxTransmissionIndication | treatAsG711SilenceSuppOff>
	sourceAddressValidation <disabled | enabled>

...

storeICID <disabled | enabled>
	strictParse <disabled | enabled>

...

support199OptionTag <disabled | enabled>

...

suppressNonRouteInviteResponse <disabled | enabled>

...

strictParse <disabled | enabled>
	timers

...

transitIOI <string>

...

transportPreference

...

preference1

...

<none

...

sctp

...

| tcp | tls-tcp | udp>

...

preference2

...

<none

...

sctp

...

| tcp | tls-tcp | udp>

...

preference3

...

<none

...

sctp

...

tcp

...

tls-tcp

...

udp>

...

preference4 <none | sctp | tcp | tls-tcp | udp>
	treatPortZeroAsNoAudio <disabled | enabled>
	uriPreference <none | sip | tel>
	useGAPWhenRnDisabled <disabled | enabled>

...

usePcfaCcf <disabled | enabled>

...

usePortRangeFlag <disabled | enabled>

...

usePSXRouteAsReqUriInReg <disabled | enabled>

...

usePsxRouteForEmergencyCall <disabled | enabled>

...

useRandomUserInfoInContactHdr <disabled | enabled>

...

validateAor <disabled | enabled>

...

variantType

...

<mgcf |

...

q1912 |

...

sonus |

...

ttc |

...

Command Parameters

...

class	pdf6pttext

...

0	Table
1	SIP Trunk Group Signaling Parameters

...

Choose an E.164 profile to associate with this SIP Trunk Group.

e164GlobalProfile <global profile name> – Name of the global E.164 Profile.
e164LocalProfile <local profile name> – Name of the E.164 Profile for local numbers.

...

Prescribed behavior associated with various 3GPP P-Headers.

addEgressOrigCa – Enable to send P-Orig-CA header on the egress side.
- disabled (default)
- enabled
insertpVisitedNetworkID – Use this parameter to set the P-Visited-Network-ID header value when receiving REGISTER, OOD INVITE and OOD non-INVITE requests from UE before the message is forwarded towards IMS core network (for example, visitedNetwork or “\”Visited Network\””). (range: 1-255 characters)
useIngressOrigCa– Enable to honor P-Orig-CA header received on the ingress side.
- disabled (default)
- enabled

...

Use this control to configure TCP Fallback settings.

maxMTUSupportedOverUDPControl– Maximum MTU Size accepted over UDP.
- disabled (default)
- enabled
maxMTUSupportedOverUDPValue – Maximum size of the SIP Invite accepted over UDP. (range: 1-5000 / default = 1300).

...

Controls the X and P Header behavior applicable to this trunk group.

HeaderFlag– Select header type allowed on SIP trunk group.
- none (default)
- xHeaders

...

Enable this flag to accept History-Info header received on the ingress trunk group.

disabled (default)
enabled

...

Set parameter to "3GPP" to select GIBA security mechanism when a REGISTER message is received without specific security headers. The

Spacevars

0	product

validates Source IP Address against Via header IP Address and transparently passes UEs Via header in egress messages towards network entities. If REGISTER message is received with "sec-agree" in Proxy-Require header along with Auth headers, and no IP Sec profile is configured, the

Spacevars

0	product

rejects the message with "4xx Bad Extension" error response irrespective of the accessClass parameter value.

When GIBA security mechanism is selected and Via header is configured to pass transparently to egress leg,

Spacevars

0	product

inserts a “received” parameter with the source IP address of the PDU if the host portion of the UE’s Via header does not equate to the source IP address seen by the

Spacevars

0	product

.

3GPP – Select to enable GIBA security mechanism as explained above.
none (default) – When selected, SBC defaults to SIP Digest without TLS authentication.

...

This flag enables the Bye-Challenge feature. When this flag is enabled, the BYE's might get challenged either by 401 or 407 and the call is released only when the BYE with appropriate credentials are received.

disabled (default)
enabled

...

Use this object to support local authentication autonomously on a per-IP trunk group basis in situations where an IP-PBX does not perform a registration and the service provider does not require/want registrations (see IP Trunk Group Authentication additional feature functionality).

authPassword <password, 6-32 characters> – Password to create Authorization Digest or Proxy-Authorization headers for trunk group authentication. These credentials are used when replying to local authentication requests.
authUserPart <userpart, 1-127 characters> – Userpart to create Authorization Digest or Proxy-Authorization headers for trunk group authentication. These credentials are used when replying to local authentication requests.
intChallengeResponse– Enable this flag on the ingress IP Trunk Group (IPTG), respective to the request, to allow the SBC to reply locally to egress IPTG authentication challenges. If this flag is disabled, the SBC will not reply to authentication challenges locally even if credentials are configured on the egress IPTG.
- disabled (default) – If this flag is disabled, incInternalCredentials is not used.
- enabled
incInternalCredentials– Enable this flag on the ingress IP Trunk Group, respective to the request, to allow egress IPTG authentication to be internally created using the authorization information in mid-dialogue without being challenged.
- disabled (default)
- enabled

Note

The

Spacevars

0	product

will not use IPTG credentials if a call originates from a surrogate originated peer even if intChallengeResponse is enabled on the ingress leg.

Note
If IPTG authentication is configured for both ingress IPTG and IP Peer, the IP Peer configuration takes precedence. If you wish to use the flags configured on IPTG, the IP Peer must not be present in the configurations. Otherwise, the IP Peer flags default to 'disabled' state and take precedence over IPTG flags.

...

If enabled, an INFO message will only be sent after confirmed Dialog.

disabled (default)
enabled

...

Specifies what SIP headers may be used when determining the Calling Party information.

cpcParamFromHeader – SIP Mapping CPC parameter from incoming call to outgoing call.
- default (default)
- fromHeader
- paitel
fromHdrForCallingParty – If enabled, the FROM header will be used to form the Calling-Party-ID provided no allowed PAI/PPI/RPI header is present.
- disabled
- enabled (default)
paiForCallingParty – If enabled, the PAI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
ppiForCallingParty – If enabled, the PPI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
rpiForCallingParty – If enabled, the RPI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)

Note
Both ppiForCallingParty and rpiForCallingParty options are not applicable in Q.1912.5 SIP-I to SIP-I scenarios. Based on the Q.1912.5 recommendation, the mapping to calling party number only occurs if a PAI header containing valid address digits (0-9) are received.

trustedSourceForIsup – Used to indicate if the message came from a trusted source and the FROM header can be used to map into ISUP parameters.
- disabled
- enabled (default)

...

cpcSipCauseMappingProfile – The name of the CPC to SIP cause mapping profile. Select any one of the option: defaultCpcSip, defaultQ1912CpcSip, defaultRFC3398CpcSip, defaultTs29163CpcSip.
sipCpcCauseMappingProfile – The name of the SIP to CPC cause mapping profile. Select any one of the option: defaultQ1912SipCpc, defaultRFC3398SipCpc, defaultSipCpc, defaultTs29163SipCpc.
sipInternalCauseMappingProfile – The name of internal cause to SIP cause mapping profile.
useNonDefaultCauseCodeforARSBlackList – Enable flag to use cause code 168 for route rejection due to ARS blacklisting.
- disabled (default)
- enabled

...

clearTcpConnectionsforRegistration

...

Enable flag to clear the TCP connection between UE and

Spacevars

0	product

once the registration becomes inactive. The

Spacevars

0	product

clears (closes) the TCP connection even when there are user agent failure registrations.

When this flag is disabled, the

Spacevars

0	product

relies on the UE to clear the TCP connection between the two If the registration becomes inactive.

disabled (default)
enabled

...

Enable this flag to use ingress message ALLOW header content in the egress message. Only methods which are configured as allowed at the egress TG are populated from ingress to the egress message. Methods with no configuration present are considered allowed (example: INVITE).

disabled (default)
enabled

...

Enable this flag to allow P-CSCF to delete parent RCB and all its childs during de-registration of any of the child IP Multimedia Public Identities (IMPUs).

disabled (default)
enabled

...

disableTermIOIForPcscf – Enable this flag to prevent P-CSCF from adding “erm-ioi” parameter to any requests while creating P-Charging-Vector (PCV) header.

disabled (default)
enabled

...

Spacevars

0	product

...

Enable this flag to change the URI scheme as described below.

disabled – (default) If flag is disabled at AS side,
Spacevars
0 product
uses SIP URI scheme. If disabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips:, as SIPS.
enabled – If flag is enabled at AS side,
Spacevars
0 product
enforces SIPS URI scheme in Request-Uri and Contact Header if request is egressed using TLS as transport. If enabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips, as SIPS.

...

Enable this flag to enforce using TLS to egress a request if the Request-URI/topmost Route header uses “sips” scheme on a per-peer group basis.

disabled – (default) If flag is disabled at AS side,
Spacevars
0 product
uses SIP URI scheme.If disabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips:, as SIPS.
enabled – If flag is enabled at AS side,
Spacevars
0 product
enforces the use of TLS for egressing any dialog initiating request if incoming request has SIPS URI scheme in either Request-Uri or top-most Non-NBS Route Header. If enabled at IAD side,
Spacevars
0 product
sets URI scheme of any header using sips, as SIPS.

...

flexiblePolicyAdapterProfile

...

Use this Trunk Group object to associate a sipAdaptorProfile configured for flexible policy (profileType=flexiblePolicy) with a particular Trunk Group.

If flexiblePolicyAdapterProfile is provisioned both at the trunk group and zone levels, the trunk group’s profile takes precedence. If inputAdapterProfile is configured, it is applied first to manipulate the PDU and then flexiblePolicyAdapterProfile rules are applied on the manipulated PDU.

...

honorMaddrParam

...

Enable this flag to allow

Spacevars

0	product

to process (and make routing decisions) the maddr parameter present in Contact header of incoming requests/responses or in Refer-To header.

disabled (default) –
Spacevars
0 product
does not perform any special processing for maddr parameter in SIP message.
enabled

The following behavior is supported with this feature:

When maddr is present in the received SIP request’s Contact Header or in the Contact header of 18x, 20x, and 3xx, SBC uses it as the remote target.
When routing based on maddr value, the
Spacevars
0 product
uses the port information present in the received Contact (or Refer-To) header.
When routing based on maddr value, the
Spacevars
0 product
uses the transport parameter present in the Contact as the new request's transport.

Note
The supports this feature even when `maddr` value is IPv4, IPv6, or FQDN (resolving to either IPv4 or IPv6).

...

nonstandard – When receiving, treat the percentage character (%) as an escape character. When sending, do not include characters not allowed by certain proxies.
rfc2806 (default) – Use for default behavior when handling ISUB parameter.
rfc3966 – Encode/decode the ISUB parameter based on the ABNF for ISUB specified in RFC3966.

...

Enable flag to transparently relay (in egress SIP signaling) an ISUP mime body received in SIP signaling. When disabled, ISUP mime bodies are decoded and interworked based on the egress signaling configuration.

disabled (default)
enabled

...

Enable flag to support the keep-alive mechanism (RFC 6223).

disabled (default)
enabled

...

Enable this flag to allow P-CSCF to globalize. To hdr in Register,req URI in SUBSCRIBE for regevt and perform a PSX dip for non-INVITE for tel URI as well as control the dial string feature.

disabled (default)
enabled

...

includeAppHdrs– Enable flag to allow Application to add headers in outgoing messages.
- disabled (default)
- enabled
inputAdapterProfile – Input Adapter Profile name.
outputAdapterProfile – Output Adapter Profile name.

...

Use this object to allow or reject various SIP methods as indicated below.

info – Determines if INFO method is included in the Allow header.
message– Determines if MESSAGE request is accepted and processed or rejected with 405 message
notify – Determines if NOTIFY request is accepted and processed or rejected with 405.
options – Determines if OPTIONS request is accepted and processed or rejected with 405.
publish – Determines if PUBLISH request is accepted and processed or rejected with 405.
refer – Determines if REFER request is accepted and processed or rejected with 405.
register – Determines if REGISTER method is included in the Allow header.
subscribe – Determines whether SUBSCRIBE request is accepted and processed or rejected with 405.
update – Determines whether UPDATE request is accepted and processed or rejected with 405.

Each parameter above includes two options:

- allow (default)
- reject

...

disabled (default) – CSTA invites are rejected with 415 “Unsupported Media Type” error message.
enabled – Relays CSTA invites to the far side.

...

disabled (default)
enabled

...

Use this Post-Dial Delay (PDD) object to configure post-dial delay performance requirement which consists of a timeout value and response code. The Ingress PDD timer is activated when the configured value on the ingress trunk group is greater than zero and the incoming SIP call reaches an address complete state. The Egress PDD timer is activated when the configured value on the egress trunk group is greater than zero and upon receipt of the 100 Trying message from the egress peer. The Egress PDD timer is canceled upon receipt of a 18x/200/3xx/4xx/5xx message from the egress peer. See Post Dial Delay Timer for feature details.

responseCode – The SIP response code sent to ingress and egress if the call is torn down due to PDD timer expiry.
timeOut – The timeout value if the Post Dial Delay is enabled.

...

Enable (on Core network side) to parse and transparently pass “pref” SIP Option tag in incoming Require header of Register message. The “pref” option tag is used to publish and request support for RFC 3840 caller capabilities.

disabled (default)
enabled

...

default (default) – Map Privacy header parameters, ID, or user to “restrict”.
idonly – Only map Privacy header parameter ID to “restrict”.

...

Use this flag to determine "tgrp" parameter behavior.

disabled (default) – If "tgrp" and "trunk-context" are present in the request URI, Route Header or 3xx is processed by the PSX depending on PSX flag setting to process the tgrp parameters.
enabled – If "trunk-context" is present in the request URI, Route Header or 3xx is checked against the SBC address. If they match, "tgrp" must be used for routing. Otherwsie, "tgrp" and "trunk-context" are relayed to the peer in the subsequent INVITE message.

...

disabled (default)
enabled

...

Defines the parameters controlling registration relay behavior.

alwaysRandomExtExpires – Use this flag to control how the random value is used for external expires timer.
- disabled (default) – The external expires timeout is randomized for the initial REGISTER.
- enabled – The external expires timeout is randomized for the initial and refresh REGISTER.
alwaysRandomIntExpires – Use this flag to control how the random value is used for external expires timer.
- disabled (default) – The internal expires timeout is randomized for the initial REGISTER.
- enabled – The internal expires timeout is randomized for the initial and refresh REGISTER.
bulkRegisterFormat – Use this flag to determine how the registration requests are formatted with respect to RFC 6140.
- disabled (default) – REGISTER message is not formatted as per RFC 6140.
- enabled – REGISTER message is formatted as per RFC 6140.
- followIngress – No changes are made to the Egress Register with respect to RFC 6140.
expires – The time (in seconds) a SIP endpoint's registration session lasts before requiring re-registration. (range: 15-65535, default = 3600). This value does not apply if the endpoint is NAT'd.
extRefreshFactorMax – Defines the maximum factor for random number calculation for external refresh timeout. (range: 0 to 1000 / default = 0).
extRefreshFactorMin – Defines the minimum factor for random number calculation for external refresh timeout. (range: 0 to 1000 / default = 0).
includeXOriginalAddr – Enable this flag to insert the X Original Addr header into REGISTER message.
- disabled (default)
- enabled
insideExpiresMinimum – Controls the initial expire value (in seconds) in a REGISTER relayed to a registrar. (range: 0-100000, default = 3600).

Note

Since the

Spacevars

0	product

expects an expires value greater than 540 seconds (9 minutes) from the registrar, do not set “insideExpiresMinimum” value less than 540 seconds. Ideally, set this value much higher (3600 seconds is recommended) to avoid overloading registrar with register refreshes.

Note
When configuring surrogate registration, be sure to set the expires value of ingress trunk group toward IAD to the maximum default value of “3600”.

intRefreshFactorMax – Defines the maximum factor for random number calculation for internal refresh timeout. (range: 0 to 1000 / default = 0).
intRefreshFactorMin – Defines the minimum factor for random number calculation for internal refresh timeout. (range: 0 to 1000 / default = 0).
requireRegistration – Use this flag to specify the type of endpoint registration validation required.
- none (default) – No registration validation is required.
- required – Use this option to prevent unregistered IADs from making or receiving any calls.
- required-nonpriority – Use this option to prevent unregistered IADs from making or receiving non-priority calls. Since priority calls are exempt, unregistered endpoints are still allowed to make priority calls.
- required-group – If this option is selected for an ingress IP trunk group in relation to a received call (e.g. call from IP-PBX towards AS) so that if the source IP address and port of the INVITE/OOD request do not match the source IP address and port of an existing registration in the zone, they are rejected. However, if the AOR does not match, but if the source IP Address and the port match to the existing registration in the zone, messages are accepted.
  If this option is selected for an egress IP trunk group in relation to a received call (e.g. call from AS towards IP-PBX), the user part check between registered AoR and Request-URI of the INVITE does not occur, and the call is accepted.
- required-group-nonpriority – Use this option to prevent unregistered IADs from making or receiving non-priority calls. All emergency calls are allowed even if the source IP/port fails to fetch RCB.
- supported – Use this option to accept registrations from unregistered endpoints when the associated trunk group is used for endpoints optionally requiring registration. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route.
- supported-group – Use this option to accept registrations from unregistered users and from users whose user names do not match with the stored URI in Registration Control Block. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route.
  Note
  Set requireRegistration flag to ‘supported-group’ for the IP Peer on which surrogate registration functionality is being enabled.
useRUriForRegisterRouting – Use this flag to specify how to handle URI for a REGISTER request.
- disabled (default) – Send the TO AOR as CALLED URI instead of Request-URI which results in default routing mechanism.
- enabled – Send the Request-URI as Called-URI, resulting in Request-URI based routing.

Note
The above flag is not supported on ERE and is intended for use with an external PSX and/or ePSX only.

...

disabled
enabled (default)

...

disabled (default)
enabled

Note
Use `relayNonInviteRequest` flag for unregistered users only.

...

disabled – Process INVITE locally.
enabled (default) – Translate dialog identifier and relay Replaces header in INVITE.

...

relayUpdatewithSdp

...

Enable this flag to relay UPDATE request with Offer immediately after receiving or sending answer in unreliable provisional responses. This flag is applicable only in case of interworking where one side supports reliable response (from where the UPDATE is received) and the other side does not (towards which it needs to be relayed).

disabled (default)
enabled

...

bye – Maximum number of retransmissions for SIP BYE request. (range: 0-12 / default = 3).
cancel – Maximum number of retransmissions for SIP CANCEL request. (range: 0-12 / default = 3).
general – Maximum number of retransmissions for generic SIP request. (range: 4-12 / default = 7).
invite – Maximum number of retransmissions for SIP INVITE request. (range: 0-6 / default = 6).
invite200 – Maximum number of retransmissions for the 200 OK for initial SIP INVITE request. (range: 0-10 / default = 0)
reInvite – Maximum number of retransmissions for SIP Re-INVITE request. (range: 0-6 / default = 3).
retryOn422 – Maximum number of session keep-alive negotiations upon receiving 422. (range: 0-12 / default = 5)
retryOn491 – Maximum number of session keep-alive negotiations upon receiving 491. (range: 0-12 / default = 5)

...

Enable this flag to allow the SBC to rewrite identities for both ingress and egress trunk groups to achieve SIP URI transparency for SIP-URIs present in outbound SIP message.

Note
To use this feature, enable `rewriteIdentities` on both ingress and egress SIP Trunk Groups.

uk>

Noprint
Back to Top

Command Parameters

Caption

0	Table
1	SIP Trunk Group Signaling Parameters

Parameter Length/
Range Description

E164Profiles

N/A

Choose an E.164 profile to associate with this SIP Trunk Group.

e164GlobalProfile <global profile name> – Name of the global E.164 Profile.
e164LocalProfile <local profile name> – Name of the E.164 Profile for local numbers.

P-HeaderExtensions

N/A

Prescribed behavior associated with various 3GPP P-Headers.

addEgressOrigCa – Enable to send P-Orig-CA header on the egress side.
- disabled (default)
- enabled
insertpVisitedNetworkID – Use this parameter to set the P-Visited-Network-ID header value when receiving REGISTER, OOD INVITE and OOD non-INVITE requests from UE before the message is forwarded towards IMS core network (for example, visitedNetwork or “\”Visited Network\””). (range: 1-255 characters)
useIngressOrigCa– Enable to honor P-Orig-CA header received on the ingress side.
- disabled (default)
- enabled

TCPFallback

N/A

Use this control to configure TCP Fallback settings.

maxMTUSupportedOverUDPControl– Maximum MTU Size accepted over UDP.
- disabled (default)
- enabled
maxMTUSupportedOverUDPValue – Maximum size of the SIP Invite accepted over UDP. (range: 1-5000 / default = 1300).

X-Headers

N/A

Controls the X and P Header behavior applicable to this trunk group.

HeaderFlag– Select header type allowed on SIP trunk group.
- none (default)
- xHeaders

acceptHistoryInfo

N/A

Enable this flag to accept History-Info header received on the ingress trunk group.

disabled (default)
enabled

accessClass

N/A

Set parameter to "3GPP" to select GIBA security mechanism when a REGISTER message is received without specific security headers. The

Spacevars

0	product

validates Source IP Address against Via header IP Address and transparently passes UEs Via header in egress messages towards network entities. If REGISTER message is received with "sec-agree" in Proxy-Require header along with Auth headers, and no IP Sec profile is configured, the

Spacevars

0	product

rejects the message with "4xx Bad Extension" error response irrespective of the accessClass parameter value.

When GIBA security mechanism is selected and Via header is configured to pass transparently to egress leg,

Spacevars

0	product

inserts a “received” parameter with the source IP address of the PDU if the host portion of the UE’s Via header does not equate to the source IP address seen by the

Spacevars

0	product

.

3GPP – Select to enable GIBA security mechanism as explained above.
none (default) – When selected, SBC defaults to SIP Digest without TLS authentication.

allowByeChallenge

N/A

This flag enables the Bye-Challenge feature. When this flag is enabled, the BYE's might get challenged either by 401 or 407 and the call is released only when the BYE with appropriate credentials are received.

disabled (default)
enabled

authentication

N/A

Use this object to support local authentication autonomously on a per-IP trunk group basis in situations where an IP-PBX does not perform a registration and the service provider does not require/want registrations (see IP Trunk Group Authentication additional feature functionality).

authPassword <password, 6-32 characters> – Password to create Authorization Digest or Proxy-Authorization headers for trunk group authentication. These credentials are used when replying to local authentication requests.
authUserPart <userpart, 1-127 characters> – Userpart to create Authorization Digest or Proxy-Authorization headers for trunk group authentication. These credentials are used when replying to local authentication requests.
intChallengeResponse– Enable this flag on the ingress IP Trunk Group (IPTG), respective to the request, to allow the SBC to reply locally to egress IPTG authentication challenges. If this flag is disabled, the SBC will not reply to authentication challenges locally even if credentials are configured on the egress IPTG.
- disabled (default) – If this flag is disabled, incInternalCredentials is not used.
- enabled
incInternalCredentials– Enable this flag on the ingress IP Trunk Group, respective to the request, to allow egress IPTG authentication to be internally created using the authorization information in mid-dialogue without being challenged.
- disabled (default)
- enabled

Note

The

Spacevars

0	product

will not use IPTG credentials if a call originates from a surrogate originated peer even if intChallengeResponse is enabled on the ingress leg.

Note
If IPTG authentication is configured for both ingress IPTG and IP Peer, the IP Peer configuration takes precedence. If you wish to use the flags configured on IPTG, the IP Peer must not be present in the configurations. Otherwise, the IP Peer flags default to 'disabled' state and take precedence over IPTG flags.

backwardInfoMsgConDialog

N/A

If enabled, an INFO message will only be sent after confirmed Dialog.

disabled (default)
enabled

callingParty

N/A

Specifies what SIP headers may be used when determining the Calling Party information.

cpcParamFromHeader – SIP Mapping CPC parameter from incoming call to outgoing call.
- default (default)
- fromHeader
- paitel
fromHdrForCallingParty – If enabled, the FROM header will be used to form the Calling-Party-ID provided no allowed PAI/PPI/RPI header is present.
- disabled
- enabled (default)
paiForCallingParty – If enabled, the PAI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
ppiForCallingParty – If enabled, the PPI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)
rpiForCallingParty – If enabled, the RPI header (if present) will be accepted to form the Calling-Party-ID.
- disabled
- enabled (default)

trustedSourceForIsup – Used to indicate if the message came from a trusted source and the FROM header can be used to map into ISUP parameters.
- disabled
- enabled (default)

Note
Both `ppiForCallingParty` and `rpiForCallingParty` options are not applicable in Q.1912.5 SIP-I to SIP-I scenarios. Based on the Q.1912.5 recommendation, the mapping to calling party number only occurs if a PAI header containing valid address digits (0-9) are received.

causeCodeMapping

N/A

Controls the mapping of CPC cause codes to/from SIP cause codes. Specify the following parameters.

cpcSipCauseMappingProfile – The name of the CPC to SIP cause mapping profile. Select any one of the option: defaultCpcSip, defaultQ1912CpcSip, defaultRFC3398CpcSip, defaultTs29163CpcSip.
sipCpcCauseMappingProfile – The name of the SIP to CPC cause mapping profile. Select any one of the option: defaultQ1912SipCpc, defaultRFC3398SipCpc, defaultSipCpc, defaultTs29163SipCpc.
sipInternalCauseMappingProfile – The name of internal cause to SIP cause mapping profile.
useNonDefaultCauseCodeforARSBlackList – Enable flag to use cause code 168 for route rejection due to ARS blacklisting.
- disabled (default)
- enabled

clearTcpConnectionsforRegistration

N/A

Enable flag to clear the TCP connection between UE and

Spacevars

0	product

once the registration becomes inactive. The

Spacevars

0	product

clears (closes) the TCP connection even when there are user agent failure registrations.

When this flag is disabled, the

Spacevars

0	product

relies on the UE to clear the TCP connection between the two If the registration becomes inactive.

disabled (default)
enabled

condIncMethInAllowHdr

N/A

Enable this flag to use ingress message ALLOW header content in the egress message. Only methods which are configured as allowed at the egress TG are populated from ingress to the egress message. Methods with no configuration present are considered allowed (example: INVITE).

disabled (default)
enabled

deRegParentWithChildDereg

N/A

Enable this flag to allow P-CSCF to delete parent RCB and all its childs during de-registration of any of the child IP Multimedia Public Identities (IMPUs).

disabled (default)
enabled

defaultCallingPartyNumber 1-15 <string> – The default calling number for Caller Privacy feature. If the party number is configured and the flag msLyncPrivacySupport is enabled, the configured number is inserted as the user name of either the from header or the P-Asserted-Identity fields depending on the configuration.

disableTermIOIForPcscf

N/A

Enable this flag to prevent P-CSCF from adding “erm-ioi” parameter to any requests while creating P-Charging-Vector (PCV) header.

disabled (default)
enabled

egressCallIdStaticString

N/A

String for generating the egress callid when configured option for egressCallIdType in PSX is "Use Static String". (default is a hyphen “-”). Egress Call-id is the aggregate of Ingress Call-id and locally generated string in

Spacevars

0	product

.

enforceSipsIfEgressIsTls

N/A

Enable this flag to change the URI scheme as described below.

disabled – (default) If flag is disabled at AS side,
Spacevars
0 product
uses SIP URI scheme. If disabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips:, as SIPS.
enabled – If flag is enabled at AS side,
Spacevars
0 product
enforces SIPS URI scheme in Request-Uri and Contact Header if request is egressed using TLS as transport. If enabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips, as SIPS.

enforceTlsIfSipsUriScheme

N/A

Enable this flag to enforce using TLS to egress a request if the Request-URI/topmost Route header uses “sips” scheme on a per-peer group basis.

disabled – (default) If flag is disabled at AS side,
Spacevars
0 product
uses SIP URI scheme.If disabled at IAD side,
Spacevars
0 product
sets the URI scheme of any header using sips:, as SIPS.
enabled – If flag is enabled at AS side,
Spacevars
0 product
enforces the use of TLS for egressing any dialog initiating request if incoming request has SIPS URI scheme in either Request-Uri or top-most Non-NBS Route Header. If enabled at IAD side,
Spacevars
0 product
sets URI scheme of any header using sips, as SIPS.

factorValue 1-50 Enter the factor value to use to interwork the SIP Max-Forwards header and the ISUP Hop counter parameter. (default = 1).

feidForPDCS 1-127 The FEID value sent out in egress PDCS-Billing-Info header when sendiing JIP value in PDCS header. FEID consists of hexadecimal string of up to 16 characters followed by a domain name (for example, abc1234@98.245.153.111).

flexiblePolicyAdapterProfile

N/A

Use this Trunk Group object to associate a sipAdaptorProfile configured for flexible policy (profileType=flexiblePolicy) with a particular Trunk Group.

If flexiblePolicyAdapterProfile is provisioned both at the trunk group and zone levels, the trunk group’s profile takes precedence. If inputAdapterProfile is configured, it is applied first to manipulate the PDU and then flexiblePolicyAdapterProfile rules are applied on the manipulated PDU.

Include Page

	ePSX_and_PSX only_Flexible_Policy
	ePSX_and_PSX only_Flexible_Policy

honorMaddrParam

N/A

Enable this flag to allow

Spacevars

0	product

to process (and make routing decisions) the maddr parameter present in Contact header of incoming requests/responses or in Refer-To header.

disabled (default) –
Spacevars
0 product
does not perform any special processing for maddr parameter in SIP message.
enabled

The following behavior is supported with this feature:

When maddr is present in the received SIP request’s Contact Header or in the Contact header of 18x, 20x, and 3xx, SBC uses it as the remote target.
When routing based on maddr value, the
Spacevars
0 product
uses the port information present in the received Contact (or Refer-To) header.
When routing based on maddr value, the
Spacevars
0 product
uses the transport parameter present in the Contact as the new request's transport.

Note

The

Spacevars

0	product

supports this feature when maddr value is IPv4, IPv6, or even FQDN (resolving to either IPv4 or IPv6).

interOperatorID 1-23 The inter-operator id (ioi) is a globally unique identifier shared between sending and receiving networks. Specify the ioi for MGCF.

isubParamPreference

N/A

This trunk group attribute specifies how the ISDN Sub-Address parameter is handled in SIP.

nonstandard – When receiving, treat the percentage character (%) as an escape character. When sending, do not include characters not allowed by certain proxies.
rfc2806 (default) – Use for default behavior when handling ISUB parameter.
rfc3966 – Encode/decode the ISUB parameter based on the ABNF for ISUB specified in RFC3966.

isupMimeBodyRelay

N/A

Enable flag to transparently relay (in egress SIP signaling) an ISUP mime body received in SIP signaling. When disabled, ISUP mime bodies are decoded and interworked based on the egress signaling configuration.

disabled (default)
enabled

keepSupport

N/A

Enable flag to support the keep-alive mechanism (RFC 6223).

disabled (default)
enabled

localNumberSupport

N/A

Enable this flag to allow P-CSCF to globalize. To hdr in Register,req URI in SUBSCRIBE for regevt and perform a PSX dip for non-INVITE for tel URI as well as control the dial string feature.

disabled (default)
enabled

maxFwdsDefault 1-100 Default value for the Max Forwards Header. (default = 70).

messageManipulation

N/A

Provides options to manipulate SIP header content. Options include:

includeAppHdrs– Enable flag to allow Application to add headers in outgoing messages.
- disabled (default)
- enabled
inputAdapterProfile – Input Adapter Profile name.
outputAdapterProfile – Output Adapter Profile name.

methods

N/A

Use this object to allow or reject various SIP methods as indicated below. See sipTrunkGroup signaling - CLI table below for details.

ocsSupport

N/A

Enable this flag to enable OCS (Office Communications Server, a.k.a MS Lync) support.

disabled (default) – CSTA invites are rejected with 415 “Unsupported Media Type” error message.
enabled – Relays CSTA invites to the far side.

outBoundSupport

N/A

Enable flag to support outbound procedures specified in RFC 5626.

disabled (default)
enabled

postDialDelay

N/A

Use this Post-Dial Delay (PDD) object to configure post-dial delay performance requirement which consists of a timeout value and response code.

The Ingress PDD timer is activated when the configured value on the ingress trunk group is greater than zero and the incoming SIP call reaches an address complete state.

The Egress PDD timer is activated when the configured value on the egress trunk group is greater than zero and upon receipt of the 100 Trying message from the egress peer. The Egress PDD timer is canceled upon receipt of a 18x/200/3xx/4xx/5xx message from the egress peer. See Post Dial Delay Timer for feature details.

responseCode – The SIP response code sent to ingress and egress if the call is torn down due to PDD timer expiry.
timeOut – The timeout value if the Post Dial Delay is enabled.

prefRequireTransparency

N/A

Enable (on Core network side) to parse and transparently pass “pref” SIP Option tag in incoming Require header of Register message. The “pref” option tag is used to publish and request support for RFC 3840 caller capabilities.

disabled (default)
enabled

privacyParamRestricted

N/A

Use this object to define SIP Privacy header parameter mapping (incoming to outgoing call).

default (default) – Map Privacy header parameters, ID, or user to “restrict”.
idonly – Only map Privacy header parameter ID to “restrict”.

processTgrpContext

Use this flag to determine "tgrp" parameter behavior.

disabled (default) – If "tgrp" and "trunk-context" are present in the request URI, Route Header or 3xx is processed by the PSX depending on PSX flag setting to process the tgrp parameters.
enabled – If "trunk-context" is present in the request URI, Route Header or 3xx is checked against the SBC address. If they match, "tgrp" must be used for routing. Otherwsie, "tgrp" and "trunk-context" are relayed to the peer in the subsequent INVITE message.

psxRouteForSubscribe

N/A

Enable this flag to use PSX routes for routing OOD (Out-Of-Dialog) methods to registered users.

disabled (default)
enabled

registration

N/A

Defines the parameters controlling registration relay behavior. See sipTrunkGroup signaling - CLI table below for details.

rel100Support

N/A

Enable to allow option tag 100rel support for the reliability of provisional messages as specified in RFC3262.

disabled
enabled (default)

relayNonInviteRequest

N/A

Enable this flag to relay non-Invite requests.

disabled (default)
enabled

Note
Use `relayNonInviteRequest` flag for unregistered users only.

relayReplacesHeader

N/A

When enabled, P-CSCF relays Replaces header with INVITE.

disabled – Process INVITE locally.
enabled (default) – Translate dialog identifier and relay Replaces header in INVITE.

relayUpdatewithSdp

N/A

Enable this flag to relay UPDATE request with Offer immediately after receiving or sending answer in unreliable provisional responses. This flag is applicable only in case of interworking where one side supports reliable response (from where the UPDATE is received) and the other side does not (towards which it needs to be relayed).

disabled (default)
enabled

retryCounters N/A Retry counter values for various SIP request types. See sipTrunkGroup signaling - CLI table below for details.

rewriteIdentities

N/A

Enable this flag to allow the SBC to rewrite identities for both ingress and egress trunk groups to achieve SIP URI transparency for SIP-URIs present in outbound SIP message.

disabled (default) – When this parameter is disabled for ingress trunk group, SBC does not send originating and terminating identities URI information as separate fields in policy request to PSX. Thus, originating and terminating identities URI information is not rewritten as per rules configured in PSX.

When this parameter is disabled for egress trunk group, SBC does not update the originating and terminating identities in outbound SIP message as per policy response from PSX.

enabled – When this parameter is enabled for ingress trunk group, SBC sends the originating and terminating identities URI information as separate fields in policy request to PSX. These originating and terminating identities URI information is rewritten as per rules configured in PSX and sent to SBC in policy response.

When this parameter is enabled, for egress trunk group, SBC updates the originating and terminating identities in outbound SIP message as per policy response from PSX. (see PSX Globalize Profile screen for configuration rules).

Note
When using this feature, be sure to enable `rewriteIdentities` on both ingress and egress SIP Trunk Groups.

rfc3261ValidateCSeqInBYE

N/A

When this flag is enabled, the SBC sends a 500 (Server Internal Error) response upon receipt of a BYE when CSeq is a lower value than the preceding INVITE request (as per RFC 3261).

disabled (default)
enabled

rfc3261ValidateInvite
200OkRetransmissions

N/A

When this flag is enabled, the SBC starts a timer for 64 * T1 (32 seconds) upon receiving a 200 OK to an INVITE. The SBC does not acknowledge re-transmitted 200 OK to an INVITE after the timer expiry. When this flag is disabled, the SBC continues to acknowledge retransmitted 200 OKs (as per RFC 3261).

disabled (default)
enabled

routeMsgValidation

N/A

Specifies if route validation should be done for the received message and if the message should be validated to ensure it is SIP-only or SIP-I. The call is released after invalidation if an invalid message type is received.

noValidation (default)
sipI – Route validation on received messages for SIP-I.
sipOnly – Route validation on received messages for SIP-only messages.

sdpTransparency

N/A

Use sdpTransparency object to enable sdpTransparencyState flag for transparently passing SDP information.

sdpTransparencyState – Enable this flag on both legs to transparently pass SDP information for this call.
- disabled (default)
- enabled

Note
Direct Media must also be enabled to use SDP Transparency for this call. See Zone - CLI for configuration details.

skipDTGLookupForRouteHdr

N/A

Enable flag to skip destination trunk group look-up on Route header when routing calls using Route headers received in a request. Egress IP trunk group is determined based on existing routing logic.

disabled (default)
enabled

sendSdpToPsx

N/A

Enable flag to pass the SDP information to the PSX (excluding data up to the first occurrence of m-line).

disabled (default)
enabled

Note
This flag is not applicable when the SBC is configured for ERE.

silenceSuppTreatment

N/A

Use this parameter to specify whether call is transitioned to fax or voice call when "silenceSupp:off" received in re-INVITE.

treatAsFaxTransmissionIndication (default) – Call is transitioned to a fax call.
treatAsG711SilenceSuppOff – If selected, the "a=silenceSupp:off" in the reInvite is interpreted as a request for voice call with silenceSupp:off.

A call is considered a fax call when Packet Service Profile applyFaxToneTreatment flag is enabled and either:

a=fax is received in the re-Invite, or
G.711 “silenceSupp:off” is received in the reInvite, and SIP Trunk Group signaling flag is set to “treatAsFaxTransmissionIndication”.

sourceAddressValidation

N/A

Enable this flag to support source address validation so that messages coming from a different IP address or port than expected are not allowed.

disabled (default)
enabled

storeICID

N/A

Enable this flag to allow SBC to retain the same ICID value generated in the first egressed INVITE for the crankback/redirect (3xx) call in the P-Charging-Vector header of the egressed INVITE.

disabled (default)
enabled

strictParse

N/A

Enable this flag on egress trunk group to reject requests which are understandable but violate the relevant RFC Augmented Backus-Naur Form (ABNF) production rule.

disabled (default)
enabled

support199OptionTag

N/A

Enable flag to include Option tag in Supported Header for the 199 Extension.

disabled (default)
enabled

suppressNonRouteInviteResponse

N/A

Enable flag to suppress the response for non-route invite.

disabled (default)
enabled

Note
With `suppressNonRouteInviteResponse` enabled, the NO_ROUTE_FOUND script is always ignored when an INVITE is dropped even if the script is returned from the ERE/PSX.

timers

N/A

Use this object to define retransmission and session keep-alive timer parameters. See sipTrunkGroup signaling - CLI table below for details.

transitIOI string: 1-63 Use this parameter to specify a transitIOI value for for inclusion in the P-Charging-Vector header. This parameter must be configured on the Trunk Group facing the transit network and the configured value is inserted on the other leg in case of an egress message. (see P-Charging-Vector Header for additional details)

transportPreference

N/A

Use this object to define the preference ordering of allowed SIP transports.

preference1
preference2
preference3
preference4

The following options apply to each of the above parameters:

none (default)
sctp
tcp
tls-tcp
udp

treatPortZeroAsNoAudio

N/A

Use this flag to control how audio portion of a call on port 0 is treated.

disabled (default) – Audio on port 0 is treated as on hold. The audio towards egress is sent out on a valid port, and the direction is set as inactive. Calls without audio m lines are supported.
enabled – Audio on port 0 is treated as 'audio-less'. The audio towards egress is sent out on port 0. Calls without audio m lines are supported.

Note
The legacy behavior of treating audio on port 0 as on hold is possible only when this flag is disabled for both ingress and egress trunk groups. If this flag is enabled on just one trunk group, the offer/answer appearing on that trunk group inherits audio-less behavior.

uriPreference

N/A

Use this object to define URI presentation preference for outgoing messages.

none (default)
sip
tel

useGAPWhenRnDisabled

N/A

Enable this flag to cause the SBC to populate the GAP/OCN in the R-URI and To headers at the egress Trunk Group. This flag is valid only when the egress profile flag "disableRn" in ipSignalingProfile is enabled.

disabled (default)
enabled

Note
If this flag is disabled and “`disableRn`” is enabled (egressIpAttributes - SIP - CLI flag), the SBC populates the routing number (rn) in the R-URI and the To headers.

usePcfaCcf

N/A

Enable this flag to use CCF received in PCFA as CDF.

disabled (default)
enabled

usePortRangeFlag

N/A

Enable this flag to allow the usage of different IP-Port as contact for each active registration towards Cisco Unified Communication Manager (CUCM). The SBC uses either an independent media port range configured per IP Trunk Group (IPTG), or a new port from the system-wide media port range if no independent media port range is configured per IPTG.

disabled (default)
enabled

Excerpt Include

	Signaling Port Range Support for Interworking with CUCM
	Signaling Port Range Support for Interworking with CUCM
nopanel	true

usePSXRouteAsReqUriInReg

N/A

Enable this flag to allow P-CSCF to use the PSX returned route as the Request URI in the register.

disabled (default)
enabled

usePsxRouteForEmergencyCall

N/A

Enable this flag to allow

Spacevars

0	product

to use PSX returned Route instead of stored-service route information for processing Emergency calls from Registered users.

disabled (default)
enabled

useRandomUserInfoInContactHdr

N/A

Enable this flag to use randomly-generated value as UserInfo in contact header.

disabled (default)
enabled

Note
To use random user-info in Contact Header, see full description on Contact Headers page.

validateAor

N/A

If enabled, the AoR must be validated. If disabled, calls from anonymous users or users whose AOR does not match with the one stored in SBC as part of RCB created during initial registration are allowed.

disabled
enabled (default)

Note
For surrogate registered users, set this flag to "disabled".

variantType

N/A

Use this parameter to specify the SIP variant type.

mgcf
q1912
sonus
ttc
uk

Noprint
Back to Top

Methods

Command Syntax

Code Block

language	none

% set addressContext <name> zone <name> sipTrunkGroup <name> signaling methods 
	info <allow | reject>
	message <allow | reject>
	notify <allow | reject>
	options <allow | reject>
	publish <allow | reject>
	refer <allow | reject>
	register <allow | reject>
	subscribe <allow | reject>
	update <allow | reject>

Command Parameters

Caption

0	Table
1	Methods Parameters
3	Methods Parameters

Parameter	Description
`info`	Determines if INFO method is included in the Allow header.
`message`	Determines if MESSAGE request is accepted and processed or rejected with 405 message
`notify`	Determines if NOTIFY request is accepted and processed or rejected with 405.
`options`	Determines if OPTIONS request is accepted and processed or rejected with 405.
`publish`	Determines if PUBLISH request is accepted and processed or rejected with 405.
`refer`	Determines if REFER request is accepted and processed or rejected with 405.
`register`	Determines if REGISTER method is included in the Allow header.
`subscribe`	Determines whether SUBSCRIBE request is accepted and processed or rejected with 405.
`update`	Determines whether UPDATE request is accepted and processed or rejected with 405.

Info

Each parameter above includes two options:

allow (default)
reject

Noprint
Back to Top

Registration

Command Syntax

Code Block

language	none

% set addressContext <name> zone <name> sipTrunkGroup <name> signaling registration 
	alwaysRandomExtExpires <disabled | enabled>
	alwaysRandomIntExpires <disabled | enabled>
	bulkRegisterFormat <disabled | enabled | followIngress>
	expires <15-65535>
	extRefreshFactorMax <0-1000>
	extRefreshFactorMin <0-1000>
	includeXOriginalAddr <disabled | enabled>
	insideExpiresMinimum <0-100000>
	intRefreshFactorMax <0-1000>
	intRefreshFactorMin <0-1000>
	requireRegistration <none | required | required-nonpriority | required-group | required-group-nonpriority | supported | supported-group>
	useRUriForRegisterRouting <disabled | enabled>

Command Parameters

Caption

0	Table
1	Registration Parameters
3	Registration Parameters

Parameter Length/Range Description

alwaysRandomExtExpires

N/A

Use this flag to control how the random value is used for external expires timer.

disabled (default) – The external expires timeout is randomized for the initial REGISTER.
enabled – The external expires timeout is randomized for the initial and refresh REGISTER.

alwaysRandomIntExpires

N/A

Use this flag to control how the random value is used for external expires timer.

disabled (default) – The internal expires timeout is randomized for the initial REGISTER.
enabled – The internal expires timeout is randomized for the initial and refresh REGISTER.

bulkRegisterFormat

N/A

Use this flag to determine how the registration requests are formatted with respect to RFC 6140.

disabled (default) – REGISTER message is not formatted as per RFC 6140.
enabled – REGISTER message is formatted as per RFC 6140.
followIngress – No changes are made to the Egress Register with respect to RFC 6140.

expires 15-65535 The time (in seconds) a SIP endpoint's registration session lasts before requiring re-registration. This value does not apply if the endpoint is NAT'd. (default = 3600)

extRefreshFactorMax 0-1000 Defines the maximum factor for random number calculation for external refresh timeout. (default = 0).

extRefreshFactorMin

0-1000

Defines the minimum factor for random number calculation for external refresh timeout. (default = 0).

includeXOriginalAddr

N/A

Enable this flag to insert the X Original Addr header into REGISTER message.

disabled (default)
enabled

0-100000

Controls the initial expire value (in seconds) in a REGISTER relayed to a registrar. (default = 3600).

Note

Since the

Spacevars

0	product

expects an expires value greater than 540 seconds (9 minutes) from the registrar, do not set “insideExpiresMinimum” value less than 540 seconds. Ideally, set this value much higher (3600 seconds is recommended) to avoid overloading registrar with register refreshes.

Note
When configuring surrogate registration, be sure to set the expires value of ingress trunk group toward IAD to the maximum default value of “3600”.

intRefreshFactorMax

0-1000

Defines the maximum factor for random number calculation for internal refresh timeout. (default = 0).

intRefreshFactorMin

0-1000

Defines the minimum factor for random number calculation for internal refresh timeout. (default = 0).

requireRegistration

N/A

Use this flag to specify the type of endpoint registration validation required.

none (default) – No registration validation is required.
required – Use this option to prevent unregistered IADs from making or receiving any calls.
required-nonpriority – Prevent unregistered IADs from making or receiving non-priority calls. Since priority calls are exempt, unregistered endpoints are still allowed to make priority calls.
required-group – If this option is selected for an ingress IP trunk group in relation to a received call (e.g. call from IP-PBX towards AS) so that if the source IP address and port of the INVITE/OOD request do not match the source IP address and port of an existing registration in the zone, they are rejected.

However, if the AOR does not match, but if the source IP Address and the port match to the existing registration in the zone, messages are accepted.
If this option is selected for an egress IP trunk group in relation to a received call (e.g. call from AS towards IP-PBX), the user part check between registered AoR and Request-URI of the INVITE does not occur, and the call is accepted.
required-group-nonpriority – Prevent unregistered IADs from making or receiving non-priority calls. All emergency calls are allowed even if the source IP/port fails to fetch RCB.
supported – Accept registrations from unregistered endpoints when the associated trunk group is used for endpoints optionally requiring registration. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route.
supported-group – Accept registrations from unregistered users and from users whose user names do not match with the stored URI in Registration Control Block. If an endpoint is registered, then the registration data is used to send calls to that endpoint instead of PSX route.

Note
Set `requireRegistration` flag to ‘supported-group’ for the IP Peer on which surrogate registration functionality is being enabled.

useRUriForRegisterRouting

N/A

Use this flag to specify how to handle URI for a REGISTER request.

disabled (default) – Send the TO AOR as CALLED URI instead of Request-URI which results in default routing mechanism.
enabled – Send the Request-URI as Called-URI, resulting in Request-URI based routing.

Note
The above flag is not supported on ERE and is intended for use with an external PSX and/or ePSX only.

Noprint
Back to Top

Retry Counters

Command Syntax

Code Block

language	none

% set addressContext <name> zone <name> sipTrunkGroup <name> signaling retryCounters 
	bye <max # retransmissions for BYE>
	cancel <max # retransmissions for CANCEL>
	general <max # retransmissions for generic>
	invite <max # retransmissions for INVITE>
	invite200 <max # retransmissions for 200 OK for initial INVITE>
	reInvite <max # retransmissions for re-INVITE>
	retryOn422 <max # session keepalives on 422>
	retryOn491 <max # session keepalives on 491>

Command Parameters

Caption

0	Table
1	Retry Counters Parameters
3	Retry Counters Parameters

Parameter	Length/Range	Description
`bye`	0-12	Maximum number of retransmissions for SIP BYE request. (default = 3).
`cancel`	0-12	Maximum number of retransmissions for SIP CANCEL request. (default = 3).
`general`	4-12	Maximum number of retransmissions for generic SIP request. (default = 7).
`invite`	0-6	Maximum number of retransmissions for SIP INVITE request. (default = 6).
`invite200`	0-10	Maximum number of retransmissions for the 200 OK for initial SIP INVITE request. (default = 0)
`reInvite`	0-6	Maximum number of retransmissions for SIP Re-INVITE request. (default = 3)
`retryOn422`	0-12	Maximum number of session keep-alive negotiations upon receiving 422. (default = 5)
`retryOn491`	0-12	Maximum number of session keep-alive negotiations upon receiving 491. (range: 0-12 / default = 5)

Noprint
Back to Top

Timers

Command Syntax

Code Block

language	none

% set addressContext <name> zone <name> sipTrunkGroup <name> signaling timers
	bfcpTimer 
		reqTimerT1 <1-10000 milliseconds>
		respTimerT2 <1-65535 milliseconds>
	nonNatKeepaliveTimer <# seconds>		
	ocsDialogTimer <# seconds>
	sctpRetransmitTimer <# seconds>
	sessionKeepalive <# seconds>
	sessionMinSE <# seconds>
	sessionTerminationDeltaTime <# seconds>
	suspendResumeTimer 
		state <disabled | enabled>
		type <both | networkTypeOnly | userTypeOnly>
		value <#>
	t1 <# milliseconds>
	t2 <# milliseconds>
	tcpRetransmitTimer <# seconds>

Command Parameters

Caption

0	Table
1	Timers Parameters
3	Timers Parameters

Parameter Length/Range Description

bfcpTimer

Binary Floor Control Protocol (BFCP) re-transmission timer includes the following two timer variables:

- reqTimerT1 – BFCP protocol request re-transmission timer T1 (in milliseconds). (range = 1-10000 / default = 500).
- respTimerT2 – BFCP protocol response re-transmission timer T2 (in milliseconds). For the configured time all subsequent duplicate requests will respond by replaying the cached response. (range = 1-65535 / default = 10000).

nonNatKeepaliveTimer Use this parameter to specify the keep-alive interval (in seconds) for a non-Nat'd device.(range 0-65535 / default = 60)

ocsDialogTime

This relay control block timer is restarted for each relay request received. If no request is received for this configured period, the dialog is deleted. When the timer is set to “0”, sessionKeepalive flag is disabled. (range: 0-10080 / default = 1440 minutes).

sctpRetransmitTime

The retransmit timer (in seconds) for SIP request over SCTP. (default = 6).

sessionKeepalive

The SIP protocol session keep-alive timer (in seconds). (range: 0-65535 / default = 1800).

sessionMinSE

Minimum expiration value (in seconds) accepted from a Session-Expires header (range: 0-65535 / default = 90).

Note

icon	false
title	Note

When sessionMinSE value is less than 90 seconds or when it equals 65535, SBC does not send an INVITE upon receiving "422 Session Interval Too Small" error message.

sessionTerminationDeltaTime

The time (in seconds) before session expiration at which the SBC sends a BYE if no session refresh request is received. This only applies when acting as the session keep-alive responder (i.e. not refresher) for a call. (range: 0-65535 / default = 0).

suspendResumeTimer

If enabled, this timer starts counting when SUSPEND ISUP message is received in SIP MIME. The timer is cancelled upon receipt of RESUME ISUP message.

state – Administrative state of timer (default is “disabled”)
value – The suspend-resume timer value, in seconds (range: 1-720 / default = 30).
type – Type of ISUP message to apply timer against.
- - userTypeOnly
  - networkTypeOnly
  - both (default)

t1

The SIP protocol retransmission timer T1 (in milliseconds). T1 is an estimate of the round-trip time (RTT). (range: 1-10000 / default = 500).

t2

The SIP protocol timer T2 (in milliseconds), and represents the maximum retransmit interval for non-INVITE requests and INVITE responses. (range: 1-65535 / default = 4000).

tcpRetransmitTimer

The retransmit timer (in seconds) for SIP request over TCP. (range: 0-15 / default = 6).

Noprint
Back to Top

Pagebreak

...

When this flag is enabled, the SBC sends a 500 (Server Internal Error) response upon receipt of a BYE when CSeq is a lower value than the preceding INVITE request (as per RFC 3261).

disabled (default)
enabled

...

When this flag is enabled, the SBC starts a timer for 64 * T1 (32 seconds) upon receiving a 200 OK to an INVITE. The SBC does not acknowledge re-transmitted 200 OK to an INVITE after the timer expiry. When this flag is disabled, the SBC continues to acknowledge retransmitted 200 OKs (as per RFC 3261).

disabled (default)
enabled

...

Specifies if route validation should be done for the received message and if the message should be validated to ensure it is SIP-only or SIP-I. The call is released after invalidation if an invalid message type is received.

noValidation (default)
sipI – Route validation on received messages for SIP-I.
sipOnly – Route validation on received messages for SIP-only messages.

...

Use sdpTransparency object to enable sdpTransparencyState flag for transparently passing SDP information.

sdpTransparencyState – Enable this flag on both legs to transparently pass SDP information for this call.
- disabled (default)
- enabled

Note
Direct Media must also be enabled to use SDP Transparency for this call. See Zone - CLI for configuration details.

...

skipDTGLookupForRouteHdr

...

Enable flag to skip destination trunk group look-up on Route header when routing calls using Route headers received in a request. Egress IP trunk group is determined based on existing routing logic.

disabled (default)
enabled

...

sendSdpToPsx

...

Enable flag to pass the SDP information to the PSX (excluding data up to the first occurrence of m-line).

disabled (default)
enabled

Note
This flag is not applicable when the SBC is configured for ERE.

...

silenceSuppTreatment

...

Use this parameter to specify whether call is transitioned to fax or voice call when "silenceSupp:off" received in re-INVITE.

treatAsFaxTransmissionIndication (default) – Call is transitioned to a fax call.
treatAsG711SilenceSuppOff – If selected, the "a=silenceSupp:off" in the reInvite is interpreted as a request for voice call with silenceSupp:off.

A call is considered a fax call when Packet Service Profile applyFaxToneTreatment flag is enabled and either:

a=fax is received in the re-Invite, or
G.711 “silenceSupp:off” is received in the reInvite, and SIP Trunk Group signaling flag is set to “treatAsFaxTransmissionIndication”.

...

Enable this flag to support source address validation so that messages coming from a different IP address or port than expected are not allowed.

disabled (default)
enabled

...

Enable this flag to allow SBC to retain the same ICID value generated in the first egressed INVITE for the crankback/redirect (3xx) call in the P-Charging-Vector header of the egressed INVITE.

disabled (default)
enabled

...

Enable this flag on egress trunk group to reject requests which are understandable but violate the relevant RFC Augmented Backus-Naur Form (ABNF) production rule.

disabled (default)
enabled

...

disabled (default)
enabled

...

Enable flag to suppress the response for non-route invite.

disabled (default)
enabled

Note
With `suppressNonRouteInviteResponse` enabled, the NO_ROUTE_FOUND script is always ignored when an INVITE is dropped even if the script is returned from the ERE/PSX.

...

timers

...

Use this object to define retransmission and session keep-alive timer parameters.

bfcpTimer – Binary Floor Control Protocol (BFCP) re-transmission timer parameter which includes the following two timer variables:
- reqTimerT1 – BFCP protocol request re-transmission timer T1 (in milliseconds). (range = 1-10000 / default = 500).
- respTimerT2 – BFCP protocol response re-transmission timer T2 (in milliseconds). For the configured time all subsequent duplicate requests will respond by replaying the cached response. (range = 1-65535 / default = 10000).
nonNatKeepaliveTimer – Use this parameter to specify the keep-alive interval (in seconds) for a non-Nat'd device.(range 0-65535 / default = 60)
ocsDialogTimer – This relay control block timer is restarted for each relay request received. If no request is received for the configured period, the dialog is deleted. When the timer is set to “0”, sessionKeepalive flag is disabled. (range: 0-10080 / default = 1440 minutes).
sctpRetransmitTimer – The retransmit timer (in seconds) for SIP request over SCTP. (default = 6).
sessionKeepalive – The SIP protocol session keep-alive timer (in seconds). (range: 0-65535 / default = 1800).
sessionMinSE – Minimum expiration value (in seconds) accepted from a Session-Expires header (range: 0-65535 / default = 90).See note below.
sessionTerminationDeltaTime – The time (in seconds) before session expiration at which the SBC sends a BYE if no session refresh request is received. This only applies when acting as the session keep-alive responder (i.e. not refresher) for a call. (range: 0-65535 / default = 0).
suspendResumeTimer – If enabled, this timer starts counting when SUSPEND ISUP message is received in SIP MIME. The timer is cancelled upon receipt of RESUME ISUP message.
- state – Administrative state of timer (default is “disabled”)
- value – The suspend-resume timer value, in seconds (range: 1-720 / default = 30).
- type – Type of ISUP message to apply timer against.
  - userTypeOnly
  - networkTypeOnly
  - both (default)
t1 – The SIP protocol retransmission timer T1 (in milliseconds). T1 is an estimate of the round-trip time (RTT). (range: 1-10000 / default = 500).
t2 – The SIP protocol timer T2 (in milliseconds), and represents the maximum retransmit interval for non-INVITE requests and INVITE responses. (range: 1-65535 / default = 4000).
tcpRetransmitTimer – The retransmit timer (in seconds) for SIP request over TCP. (range: 0-15 / default = 6).

Note

icon	false
title	Note

When sessionMinSE value is less than 90 seconds or when it equals 65535, SBC does not send an INVITE upon receiving "422 Session Interval Too Small" error message.

...

Use this object to define the preference ordering of allowed SIP transports.

preference1
preference2
preference3
preference4

For each of the above parameters, choose an option below:

none (default)
sctp
tcp
tls-tcp
udp

...

Use this flag to control how audio portion of a call on port 0 is treated.

disabled (default) – Audio on port 0 is treated as on hold. The audio towards egress is sent out on a valid port, and the direction is set as inactive. Calls without audio m lines are supported.
enabled – Audio on port 0 is treated as 'audio-less'. The audio towards egress is sent out on port 0. Calls without audio m lines are supported.

Note
The legacy behavior of treating audio on port 0 as on hold is possible only when this flag is disabled for both ingress and egress trunk groups. If this flag is enabled on just one trunk group, the offer/answer appearing on that trunk group inherits audio-less behavior.

...

Use this object to define URI presentation preference for outgoing messages.

none (default)
sip
tel

...

Enable this flag to cause the SBC to populate the GAP/OCN in the R-URI and To headers at the egress Trunk Group. This flag is valid only when the egress profile flag "disableRn" in ipSignalingProfile is enabled.

disabled (default)
enabled

Note
If this flag is disabled and “`disableRn`” is enabled (egressIpAttributes - SIP - CLI flag), the SBC populates the routing number (rn) in the R-URI and the To headers.

...

usePcfaCcf

...

Enable flag to use CCF received in PCFA as CDF.

disabled (default)
enabled

...

usePortRangeFlag

...

Enable this flag to allow the usage of different IP-Port as contact for each active registration towards Cisco Unified Communication Manager (CUCM). The SBC uses either an independent media port range configured per IP Trunk Group (IPTG), or a new port from the system-wide media port range if no independent media port range is configured per IPTG.

disabled (default)
enabled

...

disabled (default)
enabled

...

Enable this flag to allow

Spacevars

0	product

to use PSX returned Route instead of stored-service route information for processing Emergency calls from Registered users.

disabled (default)
enabled

...

Enable flag to use randomly-generated value as UserInfo in contact header.

disabled (default)
enabled

Note
To use random user-info in Contact Header, see full description on Contact Headers page.

...

If enabled, the AoR must be validated. If disabled, calls from anonymous users or users whose AOR does not match with the one stored in SBC as part of RCB created during initial registration are allowed.

disabled
enabled (default)

Note
For surrogate registered users, set this flag to "disabled".

...

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version 8

Key

SIP Trunk Group Signaling

Command Syntax

Command Parameters

Command Parameters

Methods

Command Syntax

Command Parameters

Registration

Command Syntax

Command Parameters

Retry Counters

Command Syntax

Command Parameters

Timers

Command Syntax

Command Parameters