SIP Trunk Group - Services - CLI

In this section:

Use this object to specify parameters associated with various enhanced services and features for this SIP trunk group.

Info

CLI commands are case-sensitive and must be entered exactly as shown in this guide. Objects and profiles with names that differ only in case are considered distinct objects.

For example, the following trunk groups are three distinct trunk group entities: trunkgroup1, TRUNKGROUP1, TrunkGroup1. It is strongly recommended to avoid such naming conventions, and to also adopt a standard naming convention when initially defining your configuration.

IMPORTANT

Ribbon recommends using the Transparency Profile to configure transparency on the SBC Core for new deployments, as well as applying additional transparency configurations to existing deployments. Do not use IP Signaling Profile flags in these scenarios because the flags will be retired in upcoming releases.

Refer to the SBC SIP Transparency Implementation Guide for additional information.

Note

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

SIP Trunk Group Services

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> services
	blockProgressOn3XXResponse <disabled | enabled> 
    colocatedPandEcscf <disabled | enabled>
	dialogEventNotificationSupported <disabled | enabled>
	disconnectTreatmentProfile <h323Default | sipDefault>
	dnsNaptrAlways <disabled | enabled>
    dnsSupportType <a-only | a-srv-naptr>
    dynamicBlacklistProfile <profile name>
    emergencyCallHandlingMode <emergencyRegRequired | emergencyRegSupported | none | rejectWith380>
    emergencyCallProfile <profile name>
	enhancedDblProfile <profile name>
    honorSdpClockRate <disabled | enabled> 
	hpcCallProfile
    hplmnProfile <hplmnProfile>
    jsrcBandwidthReservation <disabled | enabled>
	localSurvivability    
        localSurvivableState <enable | disable >
        allowLocalRegistration <enable | disable >
    longDurationCall 
        action <noAction | release | trap | trapAndRelease> 
        emergencyCalls <exclude | include> 
        relCause <#> 
        timeoutValue <0-44640 minutes>
    maxRouteAttempts <0-50>
	natTraversal 
    noRDIUpdateOn3XX <disabled | enabled>
    overlapAddressing 
        minDigitsForQuery <#> 
        overlapState <disabled | enabled> 
        receive <InfoMethod | MultiInvite | disabled> 
        send <InfoMethod | MultiInvite | disabled> 
        timer1 <integer> 
        timer2 <integer> 
        timer3 <integer>
    preconditionIntwkUsing183 <disabled | enabled>
    preconditions <none | required | supported | transparent>
	privacyProfile <privacyProfile name>
    remoteEPreservation <disabled | enabled>
	retryProfile <profile name>
	sipAdaptiveTransparencyProfile
	sipArsProfile <profile name>
    sipCallNotificationMetadataProfile <sipRecMetadataProfile profile name>
    sipJipProfile defaultJipProfile
    sipJurisdictionSupport <disabled | enabled>
    sipParamFilterProfile <profile name>
    sipRecMetadataProfile <sipRecMetadataProfile>
        version <0..1>
        sipHeader <sipHeader>
          sipToXmlTagName <sipToXmlTagName>
          state <disabled | enabled> 
    sipSecurityProfile <profile name>
	stiProfile <profile name>
	storeIdentityHdrtoCdr <none, shaken, div, rcd, rph, other, all>
	testCallNumberProfile <profile name>
	transmitPreconditions <none | required | supported>
    transparencyProfile <Transparency Profile name>
	usePreviousLearnedIpAddress <disabled | enabled>
    vplmnProfile <vplmnProfile>

Command Parameters

SIP Trunk Group Services Parameters

Parameter	Description
`blockProgressOn3XXResponse`	Enable this flag to prevent the SBX from generating a call forward progress (CPG) message towards the ingress side of the call. This could be mapped to an ISUP CPG on the GSX ISUP trunk or a 183 message if the ingress side is SIP. `disabled` (default) `enabled`
`colocatedPandEcscf`	Use this flag to support notification for a SUBSCRIBE with dialog event in this trunk group. `disabled` (default) `enabled` Note The ERE is not supported for this configuration. You must use an external PSX.
`dialogEventNotificationSupported`	Use this flag to support co-locating P-CSCF and E-CSCF on the ingress trunk group. `disabled` (default) `enabled` Note The ERE is not supported for this configuration. You must use an external PSX.
`disconnectTreatmentProfile`	Disconnect Treatment Profile name.
`dnsNaptrAlways`	If enabled, the SBC always sends a Naming Authority Pointer (NAPTR) query when an FQDN needs to be resolved. `disabled` (default) `enabled`
`dnsSupportType`	Indicates whether to use the DNS server for just A-record lookups, or for full NAPTR/SRV/A lookup as specified in RFC3263. `a-only` `a-srv-naptr`
`dynamicBlacklistProfile`	Dynamic Blacklist Profile name.
`emergencyCallHandlingMode`	Use this parameter to specify how to handle emergency calls. `emergencyRegRequired` – Use this option to reject the emergency session establishment without an emergency registration. Note “`usePsxRouteForEmergencyCall`” must also be enabled to use this option. `emergencyRegSupported` – Use this option when emergency registrations are supported, but emergency session establishment is possible without an emergency registration. Note “`usePsxRouteForEmergencyCall`” must also be enabled to use this option. `none` (default) – Use this option when not using emergency registrations to perform PSX dip for registered user for emergency calls. Note “`usePsxRouteForEmergencyCall`” must also be enabled to use this option. `rejectWith380` – Use this option to reject an INVITE request with ‘380 Alternate Service’ response code from Ingress leg when the request is identified as emergency request and redirection flag is set to redirection mode. See Emergency Registration for emergency registration functionality.
`emergencyCallProfile`	Emergency Call Profile name.
`enhancedDblProfile`	The name of the enhanced dynamic blacklist (DBL) profile. Refer to Enhanced DBL Profile - CLI and Configuring Enhanced Dynamic Blacklist Profile for more information.
`honorSdpClockRate`	Enable this flag to allow the mapping of up to five DTMF Payload Types (PT), each with a different clock rate of a preferred or selected payload type for audio. If the flag is disabled, all DTMF PTs except 8 kHz (both send and receive) are dropped. `disabled` (default) `enabled`
`hpcCallProfile`	The name of the HPC Call Profile. For more information, refer to HPC Call Profile - CLI.
`hplmnProfile`	Name of the HPLMN profile.
`localSurvivability`	Parameters associated with local survivability mode support which can be invoked when an Application Server is deemed unreachable by the Address Reachability Service (ARS). `localSurvivableState` - enable this flag to enable the local survivability feature. Refer to Address Reachability Service for information on call routing and registration behavior when local survivability mode is in effect. `disabled` (default) `enabled` `allowLocalRegistration` - enable this flag to allow local registration when ARS blacklists an Application Server. When enabled toward the access side of the deployment, the SBC handles new registration requests locally. The SBC accepts the registration request without authentication and locally respond with a 200OK. `disabled` (default) `enabled`
`jsrcBandwidthReservation`	Enable flag to require bandwidth reservation with Juniper Session Resource Controller. `disabled` (default) `enabled`
`longDurationCall`	The parameters associated with long duration call supervision. `action` – This is the action to take if the long duration call timer expires. `noAction` (default) `release` `trap` `trapAndRelease` `emergencyCalls` – Specifies whether Emergency Calls should be excluded from or included in Long Duration Call Disconnect procedures. `exclude` (default) `include` `relCause` – The Q.850 release value to use should the call be released due to long duration call timer expiry. (default = 41). `timeoutValue` – Timeout value (in minutes) of the long duration call timer. 0 (default) – Disable the timeout. 1-44640 – Set the timeout to the specified value.
`maxRouteAttempts`	Set the value of this parameter (0-50) to control the maximum number of egress routing attempts. Set on ingress TG, this parameter is a TG level configuration that restricts the maximum number of egress routing attempts for calls arriving on the ingress TG. Range: 0-50 Default: 0 (unlimited number of egress routing attempts) Note You must use this parameter in conjunction with the egress IP Signaling Profile control "`forceRequeryForRedirection`". For further details, refer to Egress IP Attributes - SIP - CLI.
`natTraversal`	Specifies the various parameters associated with network-hosted NAT/NAPT traversal for SIP endpoints. Specify the following NAT Traversal parameters. See NAT Traversal Parameters table below for parameter details.
`noRDIUpdateOn3XX`	Enable this flag to prevent the SBC from incrementing the redirection counter and from updating the redirection information (RDI) parameter. The RDI counter value and RDI parameter could be used to update the (diversion headers or ISUP IAM MIME content) in the subsequent SIP INVITE for the SBX or GSX, or it could also be used to update the ISUP IAM parameter if the call gets redirected over the GSX. `disabled` (default) `enabled`
`overlapAddressing`	Parameters associated with overlap addressing support. `minDigitsForQuery` – Minimum number of digits that need to be received before attempting to route the call. (range: 0-30 / default = 0). `overlapState` – Specifies the whether to support or not support overlap addressing. `disabled` (default) `enabled` `receive` – Use this parameter to specify the Incoming overlap type. `InfoMethod` – Select to support Info-based overlap dialing where initial INVITE with incomplete called party digits is answered locally by the SBC to establish early dialog, and subsequent digits are received through INFO message to complete dial sequence. `MultiInvite` – Select to process multiple INVITEs for the same call with additional digits to complete the dial sequence. `disabled` (default) – Select to disable this feature. `send` – Use this parameter to specify the Outgoing overlap type. `InfoMethod` – Select to support Info-based overlap dialing where initial INVITE with incomplete called party digits is answered locally by the SBC to establish early dialog, and subsequent digits are received through INFO message to complete dial sequence. `MultiInvite` – Select to process multiple INVITEs for the same call with additional digits to complete the dial sequence. `disabled` (default) – Select to disable this feature. `timer1` – Specifies the maximum time (in seconds) between collection of digits. (range: 5-15 / default = 10) `timer2` – Maximum time (in seconds) between sending an INVITE and receiving a backward message. (range: 0-14 / default = 0). `timer3` – Maximum time (in seconds) between receiving a 484 Address Incomplete message (if there are no outstanding INVITE transactions) and the receipt of fresh address information. (range: 4-64 / default = 4).
`preconditionIntwkUsing183`	(This flag is for specific call flows and is not intended for generic use) Enable this flag to locally generate first 183 responses for preconditions interworking before egressing INVITE. If disabled, these responses are dropped. `disabled` (default) `enabled` Note Do not enable `preConditionIntwkUsing183` when End-to-End Prack is configured.
`preconditions`	Use this parameter to level of preconditions support for incoming (only) requests. `none` – (default) `required` `supported` `transparent` – Select this option to allow the SBC to pass the received precondition option tag (either in require or supported) and precondition attributes present in SDP transparently. Note The `transparent` option must be configured on both Egress and Ingress legs. For precondition support of outgoing requests, see `transmitPreconditions` flag below.
`privacyProfile`	`<privacyProfile name>` – The name of the Privacy Profile to attach to this SIP trunk group. Refer to Privacy Profile - CLI for configuration details.
`remoteEPreservation`	Enable flag to require bandwidth reservation with the Juniper Session Resource Controller for the remote endpoint. `disabled` (default) `enabled`
`retryProfile`	The name of the SIP Retry Profile. Refer to Retry Profile - CLI and Configuring SRTP to RTP Fallback for more information.
`sipAdaptiveTransparencyProfile`	The name of the SIP Adaptive Transparency Profile. Note: The SBC gives precedence to SIP Privacy handling when the SIP Adaptive Transparency Profile is enabled. For example, if the incoming SIP message has "privacy: Id" and the flag `applyPrivacyId` under `profiles services privacyProfile` is set to `enable`, the SBC does not include `P-ASSERTED-ID` header in the egress message. For information on SIP Adaptive Transparency Profile, refer to SIP Adaptive Transparency Profile - CLI.
`sipArsProfile`	The name of the SIP ARS (Address Reachability Service) profile.
`sipCallNotificationMetadataProfile`	Specifies the name of a SIPREC metadata profile that defines the mapping of a SIP header to the Session-Id XML element in NOTIFY messages. This parameter should be set on the trunk group used to send call notifications. Refer to Services - SIP Rec Metadata Profile for information on these profiles. Refer to Sending Unsolicited Call Notifications to Application Servers for more information on the SBC's call notification feature.
`sipJipProfile`	`defaultJipProfile` is the name of the default SIP JIP profile assigned to SIP trunk groups. You can specify the name of a custom profile you created. Refer to SIP JIP Profile - CLI. Note This parameter is only supported when the SBC is configured to use an external PSX.
`sipJurisdictionSupport`	Enable this flag to allow sending JIP information in SIP-SIP, SIP-SIP-I and SIP-I to SIP scenarios. `disabled` (default) `enabled` Note This flag is only supported when the SBC is configured to use an external PSX.
`sipParamFilterProfile`	The name of the SIP Param Filter Profile.
`sipRecMetadataProfile`	Indicates the name of the profile and specifies the SIP headers that are included in the SRS call. `version` – Indicates the SIPREC metadata profile version. The options are: `0` (default) – When the version is set as 0, the SBC supports backward compatibility and predefined metadata for passing proprietary call specific information from the SRC to the SRS. `1` – When the version is set as 1, the SBC supports dynamic configuration of the metadata variables. `sipHeader` – Indicates the SIP header, which are included in the SRS call. (Length: 1-31) Note No more than 32 SIP headers can be created in one `sipRecMetadataProfile`. `sipToXmlTagName` – Indicates XML tag name for the configured SIP header. (Length: 1-31) `state` – Indicates the admin state of the SIPREC metadata profile. The options are: `disabled` (default) `enabled`
`sipSecurityProfile`	The name of the SIP Security Profile.
`stiProfile`	The name of the STI Profile. Refer to STI Profile - CLI.
`storeIdentityHdrtoCdr`	The SBC stores the base64 decoded Identity headers received and sent in the SIP INVITE message. Use this flag to specify the Identity headers to store in the CDR record. `all` `div` `none` (default) `other` `rcd` `rph` `shaken` Note You can specify all the identity headers in the list to store them in the CDR, or choose the ones you require. However, if you select 'none' and another option, for example 'shaken', 'none' takes precedence and no identity headers are stored in the CDR. Similarly, if you select 'all' and another identity header, for example 'shaken'. The choice 'all' takes precedence and all the identity headers in the list are stored in the CDR. The priority order for writing in the CDR from the highest to the lowest is, SHAKEN, RPH, RCD, DIVs and OTHER. A maximum of nine identity headers are logged in the CDR for ingress and egress. If the higher priority headers take up all the space, then the lower priority headers are not written in the CDR. When more than one SHAKEN header arrives in the Ingress INVITE, then the following is the order of precedence in which the Identity header is picked: SHAKEN header with Attestation Level 'A is picked. If more than one SHAKEN header with Attestation 'A' level is present, the top-most A level SHAKEN header is picked. If no Attestation Level 'A' SHAKEN header is present, then Attestation level 'B' SHAKEN header is picked. If more than one SHAKEN header with 'B' level is present, the top most 'B' level SHAKEN header is picked. If no Attestation Level 'B' SHAKEN header is present, then Attestation level 'C' SHAKEN header is picked. If more than one SHAKEN header with Attestation 'C' level is present, the top-most 'C' level SHAKEN header is picked.	O
`testCallNumberProfile`	The SIP Test Call Profile used for this trunk group. Refer to Test Call Number Profile - CLI.
`transmitPreconditions`	Indicates level of preconditions support for outgoing request/response. `none` – When set to "none", the Unable to show "metadata-from": No such page "_space_variables" does not add SIP precondition attributes in SDP of outgoing request even if attributes are present in the SDP of incoming requests. `required` – Use this option to add SIP precondition attributes in SDP of outgoing request even if attributes are NOT present in the SDP of incoming requests. If precondition attributes are added by the Unable to show "metadata-from": No such page "_space_variables" , the local preconditions are set to ‘met’ and remote preconditions are set to ‘not-met’. `supported` – (default) Use this option to ensure backward compatibility behavior. Use this option to add SIP precondition attributes in SDP of outgoing request only if attributes are present in the incoming request.
`transparencyProfile`	The name of the Transparency Profile to associate with this SIP trunk group.
`usePreviousLearnedIpAddress`	Enable the flag to send new SIP requests mid-dialog to the previously-learned IP address before performing any SRV DNS query. The previously-learned IP address is updated in the following cases: SBC receives an INVITE from the peer. SBC receives re-INVITE from the peer. SBC receives 200 OK response to INVITE sent. SBC receives 200 OK response to re-INVITE sent. If a time-out occurs on requests sent to previously-learned Active IP address mid-dialog, a SRV DNS look up is performed. `disabled` (default) `enabled`
`vplmnProfile`	Name of the VPLMN profile.

Command Example

Local Survivable Mode for Calls and Registrations

set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability localSurvivableState enabled
set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability allowLocalRegistration enabled

To view the status of the local survivability state and allow local registration, execute the command:

show addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability
localSurvivabilityState enabled;
allowLocalRegistration  enabled;
[ok]

NAT Traversal

Command Syntax

% set addressContext <name> zone <name> sipTrunkGroup <name> services natTraversal 
	adaptiveLearning
		maxTcpPinholeTimer <60-65535>
		maxUdpPinholeTimer <60-65535>
		reLearningInterval <1-240>
		state <disabled | enabled> 
	iceSourceAddressFilterPriority
		serverReflexivePrefixLength <unsignedInt | 0..32>
        state <disabled | enabled>
	iceSupport 
		none
		iceWebrtc
		iceLync
			iceKeepaliveTimer <0-60 seconds>
		iceFull
			iceKeepaliveTimer <0-60 seconds>
	iceTcpRole <active | passive>
	learnNatForRtpOnly <disabled | enabled>
	mediaNat <disabled | enabled> 
	disableMediaNatIfSameMediaAndSigIp <disabled | enabled>
	outboundTcpKeepaliveTimer <0-32767> 
	outboundUdpKeepaliveTimer <0-32767>
	qualifiedPrefix <IPv4 address> 
	secureMediaNatPrefix <0-32>
	signalingNat <disabled | enabled>
	tcpKeepaliveTimer <15-65535> 
	udpKeepaliveTimer <15-65535>

Command Parameters

NAT Traversal Parameters

Parameters	Length/Range	Description
`adaptiveLearning`	N/A	Adaptive NAT pinhole learning parameters. `maxTcpPinholeTimer` – Defines upper limit of the pinhole timeout for TCP in seconds. (range: 60-65535 / default = 600). `maxUdpPinholeTimer` – Defines the upper limit of the pinhole timeout for UDP in seconds. (range: 60-65535 / default = 180). `reLearningInterval` – Interval in hours at which the pinhole timeout is relearned. (range: 1-240 / default = 24). `state`– Enables/disables the adaptive nat pinhole timeout learning process for devices behind NAT. `disabled` (default) `enabled`
`iceSourceAddressFilterPriority`	N/A	Enable this parameter for the SBC to prioritize the processing of STUN packets matching the source addresses received in the candidate lines of the ICE SDP received from the peer during the STUN connectivity check phase. `serverReflexivePrefixLength` – The length (in bits) of the prefix for server reflexive IP address (range: 0-32 / default = 16). `state` – Administrative state of `iceSourceAddressFilterPriority`. `disabled` `enabled` (default) Note The filtering mechanism is applicable to the following RTP address types: IPV4 Server Reflexive Address (for this address type, filtering is based on the provisioned Server Reflexive Prefix Length) IPV4 Relay Address IPV6 Relay Address IPv6 Host Address Note When ICE Source Address Filtering is enabled, STUN packets received during the connectivity check phase that do not match the addresses sent by the peer are still processed, but at a reduced rate. This allows the SBC to learn of the presence of Peer Reflexive Candidates through STUN. This has no impact during a stable call when only packets received from the learned source address are processed and the remaining are dropped by default.
`iceSupport`	N/A	This parameter indicates the type of ICE method used for STUN packet check. `none` (default) `iceWebrtc` – Select this attribute for WebRTC Gateway interworking. For example, using the Ribbon WRTC Gateway, or in situations when the SBC is presented with an ICE SDP from a WebRTC-enabled Endpoint. When configured for this mode, the SBC acts as a generic ICE-Lite agent. `iceLync` – Select this attribute when interworking with a Microsoft Lync 2010 or 2013 client. `iceKeepaliveTimer` – Set Keep-Alive timer value, in seconds, for MS-Lync ICE to prevent network loss of STUN message exchanges. (range: 1-60 / default = 15) `iceFull` – Select this attribute when interworking with a full ICE client requiring the generation of a STUN connectivity check by the SBC in response to its own STUN connectivity check. `iceKeepaliveTimer` – Set Keep-Alive timer value, in seconds, for full-ICE to prevent network loss of STUN message exchanges. (range: 1-60 / default = 15) Note For MS Lync ICE (`iceLync` setting), keep-alive messages are sent only to RTP port. Note Ribbon recommends to avoid configuring both Media Nat and ICE Support on the same Trunk Group because these configurations are independent mechanisms for solving NAT traversal issues. Because of of this, these configurations should not coexist on the same Trunk Group. Refer to Configuring SBC for WRTC for ICE-Lite configuration best practices.
`iceTcpRole`	N/A	Use this flag to specify if SBC initiates the TCP connection for ICE Lync. `active` – Use this option for the SBC to initiate the TCP connection when connected to internal-facing trunk groups where the peer is not behind the NAT. Also, use this option when working with certain Unified Communication (UC) servers such as Acano which expect the peer to initiate the TCP connection. This is only supported when there are no NATs between the SBC and the UC server. `passive` (default) – The SBC waits for the peer to initiate the TCP connection. Use this option when working directly with Lync endpoints. Note The `iceSupport` parameter must be set to `IceLync` to configure this flag.
`learnNatForRtpOnly`	N/A	Enable flag to learn media NAT from the first RTP packet only. If disabled, media NAT is learned from any first packet received. For egress trunk groups, this flag is applicable only if `dynamicLRBT` flag is disabled. If `dynamicLRBT` is enabled, NAPT learning occurs on arrival of RTP packet until the call is connected, at which point `learnNatForRtpOnly` applies even for egress trunk groups. `disabled` (default) `enabled` Note The flag `mediaNat` must be enabled to use this flag. Note Do not enable `learnNatForRtpOnly` for SIP trunk groups with `iceSupport` enabled because it does not apply to ICE NAT traversal.
`mediaNat`		Specifies the whether or not NAT/NAPT support is required for media. `disabled` (default) `enabled` Note Ribbon recommends to avoid configuring both Media Nat and ICE Support on the same Trunk Group because these configurations are independent mechanisms for solving NAT traversal issues. Because of of this, these configurations should not coexist on the same Trunk Group. Note The SBC Core does not support NAT traversal for IPv6 calls. Ensure NAT is disabled in pure IPv6 call scenarios.
`disableMediaNatIfSameMediaAndSigIp`	N/A	Enable this flag to disable Media NAT if Media and Signaling IP addresses are identical. `disabled` (default) `enabled`
`outboundTcpKeepaliveTimer`	0-32767	The NAT outbound keep-alive timer (in seconds) for SIP over TCP (default = 240)
`outboundUdpKeepaliveTimer`	0-32767	The NAT outbound keepalive timer (in seconds) for SIP over UDP (default = 60)
`qualifiedPrefix`	N/A	Set of IP network media and signaling prefixes that an address must match to be considered for NAT handling. If there are no entries in `qualifiedPrefix` table, the endpoint is treated as existing behind a NAT device. As a result, the SBC considers requests from all IP addresses to be behind a NAT device. `ipAddress` – IPv4 address. `prefixLength` – Value from 0-128 specifying the number of bits representing the network part of `ipAddress`.
`secureMediaNatPrefix`	0-32	Use this parameter to match up to 'N' bits of the network IPv4 address obtained from signaling. If set to "0", feature is disabled, and no match of network IP address will occur. (default = 0)
`signalingNat`	N/A	This indicates whether or not NAT/NAPT support is required for signaling. `disabled` (default) `enabled` Note The SBC Core does not support NAT traversal for IPv6 calls. Ensure NAT is disabled in pure IPv6 call scenarios.
`tcpKeepaliveTimer`	15-65535	This NAT TCP keep-alive timer sets the registration refresh rate (in seconds) for SIP over TCP. (default = 240).
`udpKeepaliveTimer`	15-65535	This NAT UDP keep-alive timer sets the registration refresh rate (in seconds) for SIP over UDP. (default = 60).

Space shortcuts

Page tree

SIP Trunk Group Services

Command Syntax

Command Parameters

Command Example

NAT Traversal

Command Syntax

Command Parameters