In this section:
Use this object to specify parameters associated with various enhanced services and features for this SIP trunk group.
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.
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.
As a best practice, always use UPPERCASE for trunk group names.
% 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>
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.
| |
colocatedPandEcscf | Use this flag to support notification for a SUBSCRIBE with dialog event in this trunk group.
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.
Note
The ERE is not supported for this configuration. You must use an external PSX. | |
disconnectTreatmentProfile | Disconnect Treatment Profile name. | |
| If enabled, the SBC always sends a Naming Authority Pointer (NAPTR) query when an FQDN needs to be resolved.
| |
dnsSupportType | Indicates whether to use the DNS server for just A-record lookups, or for full NAPTR/SRV/A lookup as specified in RFC3263.
| |
dynamicBlacklistProfile | Dynamic Blacklist Profile name. | |
emergencyCallHandlingMode | Use this parameter to specify how to handle emergency calls.
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.
| |
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).
| |
jsrcBandwidthReservation | Enable flag to require bandwidth reservation with Juniper Session Resource Controller.
| |
longDurationCall | The parameters associated with long duration call supervision.
| |
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.
Note
You must use this parameter in conjunction with the egress IP Signaling Profile control " | |
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.
| |
overlapAddressing | Parameters associated with overlap addressing support.
| |
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.
Note
Do not enable | |
preconditions | Use this parameter to level of preconditions support for incoming (only) requests.
Note
The For precondition support of outgoing requests, see | |
privacyProfile |
| |
remoteEPreservation | Enable flag to require bandwidth reservation with the Juniper Session Resource Controller for the remote endpoint.
| |
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 | |
| 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 |
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.
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.
| |
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.
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.
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:
| 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.
| |
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:
If a time-out occurs on requests sent to previously-learned Active IP address mid-dialog, a SRV DNS look up is performed.
| |
vplmnProfile | Name of the VPLMN profile. |
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
show addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability localSurvivabilityState enabled; allowLocalRegistration enabled; [ok]
% 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> iceTrickle <disabled | enabled> 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>
Parameters | Length/Range | Description |
---|---|---|
adaptiveLearning | N/A | Adaptive NAT pinhole learning parameters.
|
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.
Note
The filtering mechanism is applicable to the following RTP address types:
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.
Note
For MS Lync ICE ( 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.
Note
The |
iceTrickle | N/A | Trickle ICE is a mechanism that allows ICE agents to shorten session establishment delays by making the candidate gathering and connectivity checking phases of ICE non-blocking and by issuing them in parallel. This allows starting the call setup procedure to the SBC before all candidates have been gathered by the user agent so that additional candidates can be sent to the SBC in subsequent INFO and/or offer and answer messages. Use this flag to enable Trickle ICE support for this trunk group.
Before using this feature in production, fully verify the functionality in the lab. |
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.
Note
The 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.
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.
| |
disableMediaNatIfSameMediaAndSigIp | N/A | Enable this flag to disable Media NAT if Media and Signaling IP addresses are identical.
|
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.
|
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.
|
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). |