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.
This section lists the CLI to configure the following SIP egress IP attributes involved in sending a call in the forward direction to the peer.
SIP egress IP attributes:
BCI
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes bci bciInterworkEncountered <disable | enable> bciIsdnAddess <disable | enable>
Command Parameters
BCI Parameters
Parameter | Description |
---|---|
| Use this object to configure Backward Call Indicator (BCI) for Egress IP attributes.
|
Domain Name
Use this object to specify use of domain names.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes domainName useIpSignalingPeerDomainInRequestUri <disable | enable> useSipDomainInPAIHeader <disable | enable> useSipDomainNameInFromField <disable | enable> preserveIngressFromDomainName <disable | enable> useLowerCaseDomainNames <disable | enable> useSipDomainNameInRequestUri <disable | enable> preserveIngressRUriDomainName <disable | enable> useLowerCaseDomainNames <disable | enable> useZoneLevelDomainNameInContact <disable | enable> useZoneLevelDomainNameInPathHdr <disable | enable>
Command Parameters
Domain Name Parameters
Parameter | Description |
---|---|
useIpSignalingPeerDomainInRequestUri | Enable this flag to use IP Signaling Peer Domain in Request URI.
|
| Enable this flag to set the value of the host port of the PAI URI equivalent to the value of the SIP domain name configured on the ingress trunk group of the Policy Exchange Server (PSX).
|
useSipDomainNameInFromField | By default, the Unable to show "metadata-from": No such page "_space_variables" uses its IP address as the host-port of the FROM URI in the outgoing INVITE message. Enable flag to use the originating gateway information returned in the policy response as the host-port of the FROM URI in the outgoing INVITE message.
When
NOTE: The above two flags only apply when a Domain Name is configured for this zone (refer to Zone - CLI). |
useSipDomainNameInRequestUri | Use this flag to indicate how to treat SIP Domain name in outgoing SIP INVITE.
When
|
| Enable this flag to use Zone level domain name in the Contact header.
|
useZoneLevelDomainNameInPathHdr | Enable this flag to send the Domain Name configured at the Zone level in the Path Header of the outgoing REGISTER message.
|
Flags
Use this object to set egress IP attribute flags.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes flags addLoopBackRouteHeader <disable | enable> bgcfTargetSchemeTransparency <disable | enable> convertInactiveToSendrecv <disable | enable> disable2806Compliance <disable | enable> disableOptionalRegisterParameters <disable | enable> ignoreSdpAfterOfferAnswerCompleted <disable | enable> includeEnumParameters <disable | enable> map3xxContactUrlToRouteHeader <disable | enable> map181Or182MessageTo183 <disable | enable> mapContractorNumberInPSigInfoHeader <disable | enable> monitorRtpOnEgressUpdate <disable | enable> qosBasedRouting <disable | enable> sameCallIdForRequiredAuthorization <disable | enable> suppressUnregister <disable | enable> transitPAIFromUnregisteredPeer <disable | enable> ttcIsupMapping <disable | enable> useCalledPartyInRequestUri <disable | enable> useColonInSdpMediaTypeParameter <disable | enable> validateIsubAddress <disable | enable>
Command Parameters
Flags Parameters
Parameter | Description |
---|---|
addLoopBackRouteHeader | Enable flag to add the SBC URI as the second top-most Route header in the INVITE towards EATF.
|
bgcfTargetSchemeTransparency | Enable flag to preserve the scheme used by the SIP INVITE Request-URI when the INVITE is routed by the Unable to show "metadata-from": No such page "_space_variables" , acting as a BGCF supporting Tel-URL. When disabled, the SBC changes the scheme used by the Request-URI parameter to SIP in the egress INVITE message.
|
convertInactiveToSendrecv | Enable flag to control the a-line in the SDP of an egress SIP INVITE message by converting a=inactive to a=sendrecv. When disabled, the Unable to show "metadata-from": No such page "_space_variables" continues to use a=inactive, when appropriate, in the egress INVITE message.
|
disable2806Compliance | If enabled, the 2806 Compliance Code is disabled and no phone context or user=phone parameters are signaled in egress messages.
|
disableOptionalRegisterParameters | Enable flag to prevent Unable to show "metadata-from": No such page "_space_variables" from sending the DTG (Destination Trunk Group) parameter in the Contact header of egress REGISTER messages.
|
| Enable flag to allow the SBC to ignore the new SDP at the egress leg in subsequent 1xx-rel or final 200 OK messages after the Offer Answer for the initial Invite dialog was completed by an earlier 1xx-rel (and does not trigger a new offer or answer).
|
includeEnumParameters | Use this flag to specify how to handle ENUM parameters in outgoing INVITE.
|
map3xxContactUrlToRouteHeader | When map3xxContactUrlToRouteHeader flag is enabled, SBX adds 3XX contact header as second route header in the outgoing INVITE message. This flag is enabled on a IBCF TG because when a call is routed by ECSCF to IBCF, the 3xx contact URI need to be added as second route header for subsequent routing to IP-PSAP.
|
map181Or182MessageTo183 | Enable flag to allow Unable to show "metadata-from": No such page "_space_variables" to map 181 or 182 response messages to 183. When disabled, the SBC handles 1xx response messages normally.
|
mapContractorNumberInPSigInfoHeader | Enable flag to map the Contractor Number parameter into the outgoing SIP P-Sig-Info header. The P-Sig-Info header is a customer-specific SIP header used to convey ISUP information in SIP messages.
|
monitorRtpOnEgressUpdate | This flag is used to decide whether to start tone and monitor RTP or not.
|
qosBasedRouting | Enable flag to allow QoS-based routing.
|
sameCallIdForRequiredAuthorization | Enable this flag to support sending an INVITE with credentials on receiving a 401 (Unauthorized) or 407 (Proxy Authentication Required) response to initial INVITE with the same call ID as in the original INVITE.
NOTE: To view and configure this flag, you must first enable both 'authCodeHeaders' transparency flag and 'statusCode4xx6xx' relay flag. Refer to Transparency Flags - CLI and Relay Flags - CLI for additional details. |
suppressUnregister | Enable flag to prevent Unable to show "metadata-from": No such page "_space_variables" from sending an unregister message (Register=0) to the registrar upon expiration of a SIP UA registration. When disabled, the Unable to show "metadata-from": No such page "_space_variables" generates unregister messages on the egress leg if the UA does not refresh the registration on time.
|
| Enable flag to transparently pass the received PAI to the INVITE if the default PUI procedure cannot add a PAI header.
NOTE: To use this flag, you must enable the enableDefaultPUIProcedures flag and disable the 'privacy transparency' flag (See Privacy section below). |
ttcIsupMapping | When enabled, and when the IP protocol type of the IP signaling profile entry is SIP or SIP-I, the application that receives the Unable to show "metadata-from": No such page "_space_variables" policy response (which can be either the SIP signaling gateway application on the Unable to show "metadata-from": No such page "_space_variables" or the SIP core proxy on the Unable to show "metadata-from": No such page "_space_variables" ) applies the mapping necessary for TTC-ISUP signaling.
|
useCalledPartyInRequestUri | When enabled, the Unable to show "metadata-from": No such page "_space_variables" copies the username selected for the "To" header to the Request URI instead of the registered username. When disabled, the Unable to show "metadata-from": No such page "_space_variables" includes the registered username in the Request URI. This flag is used when interoperating with IP-PBXs that require the real end station number in the Request URI in order to do proper routing of calls terminating on them.
|
useColonInSdpMediaTypeParameter | When enabled, a colon (:) is used as the separator between the SDP Media Type parameter key and value. When disabled, an equal sign (=) is used as the separator between the SDP Media Type parameter key and value.
|
validateIsubAddress | When enabled, the Unable to show "metadata-from": No such page "_space_variables" validates ISUB digits for called and calling parties. When isabled, the Unable to show "metadata-from": No such page "_space_variables" will not validate ISUB digits. |
ISUB
Use this object to configure ISDN Calling Party Subaddress (ISUB) parameters:
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes isub allowNsapIsub <disable | enable> allowUserSpecifiedIsub <disable | enable> includeCalledPartyIsub <disable | enable> includeCallingPartyIsub <disable | enable>
Command Parameters
ISUB Parameters
Parameter | Description |
---|---|
allowNsapIsub | Enable to allow NSAP ISUB parameter.
|
allowUserSpecifiedIsub | Allow user-specified ISUB.
|
includeCalledPartyIsub | Include called party ISUB.
|
includeCallingPartyIsub | Include calling party ISUB.
|
Media QOS KPI Profile
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes mediaQosKpiProfile <profile_name>
Command Parameter
Media QOS KPI Profile Parameter
Parameter | Description |
---|---|
| The Media QoS KPI (Key Performance Indicator) Profile name. |
Number Globalization Profile
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes numberGlobalizationProfile <profile_name>
Command Parameters
Number Globalization Profile Parameter
Parameter | Description |
---|---|
| The Number Globalize Profile name. This profile converts numbers to SIP global number format. |
Number Portability Attributes
Number portability attributes configuration.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes numberPortabilityAttributes disableRn <disable | enable> npdiOptions <doNotIncludeNpdi | includeNpdi | includeNpdiYes>
Command Parameters
Number Portability Attributes Parameters
Parameter | Description |
---|---|
disableRn | Enable flag to prevent the Unable to show "metadata-from": No such page "_space_variables" and ERE SIP proxy/redirector from sending the SIP rn parameter in the egress INVITE message when an LNP translated number is present. When the flag is disabled, the Unable to show "metadata-from": No such page "_space_variables" and ERE SIP proxy/redirector send "rn=NNNN" in the userinfo portion of the Request URI, where "NNNN" is the LNP translated number.
|
npdiOptions | Use the following options to specify whether the Unable to show "metadata-from": No such page "_space_variables" and ERE SIP proxy/redirector send the SIP NPDI parameter in the egress INVITE message when LNP translation is performed by ERE call processing or the preceding switch.
|
P-Charge Info
Use this parameter to configure egress P-Charge-Info header in INVITE message behavior.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes pChargeInfo includeNOA <disable | enable> includeNPI <disable | enable> pChargeInfoTransparency <disable | enable> pChargeInfoType <headerParameter | uriParameter | userParameter>
Command Parameters
P-Charge Info Parameters
Parameter | Description |
---|---|
includeNOA | Enable flag to include Nature of Address Indicator in egress P-Charge-Info header in INVITE message.
|
includeNPI | Enable flag to include Number Plan Indicator in egress P-Charge-Info header in INVITE message.
|
pChargeInfoTransparency | Enable flag to transparently pass egress P-Charge-Info header in INVITE message.
|
pChargeInfoType | The format types for which NPI/NOA are encoded in P-Charge-Info header. Options include:
|
Phone Context Parameter Length
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes phoneContextParameterLength (0-31)
Command Parameter
Phone Context Parameter Length Parameters
Parameter | Length/Range | Description |
---|---|---|
| 0-31 | Use this attribute to specify the length of phone-context parameter sent in RURI and To headers of the egress message (default = 0). When a value greater than "0" is configured, and the called number is globalized using the existing globalization profile, the PSX sends the configured value in a policy response to the Unable to show "metadata-from": No such page "_space_variables" . The Unable to show "metadata-from": No such page "_space_variables" uses this configured value to insert phone-context parameter of received length in RURI and To headers. |
Privacy
Use this object to specify Privacy parameters.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes privacy anonymizeHostIpPortion <disable | enable> flags includeEmbeddedPAIheaderInRedirectedInvite <disable | enable> includePrivacy <disable | enable> msLyncPrivacySupport <disable | enable> privacyRequiredByProxy <disable | enable> privacyInformation <pAssertedId | pPreferredId | remotePartyId> transparency <disable | enable>
Command Parameters
Privacy Parameters
Parameter | Description |
---|---|
| When the flag is set to Unable to show "metadata-from": No such page "_space_variables" anonymizes the incoming host IP portion of the private headers (P-AID, P-PID, RPID) by replacing it with the IP address of the Unable to show "metadata-from": No such page "_space_variables" before sending it to the egress leg of a call.
Note: This flag is available for configuration only when the This feature supports in-dialog messages only, plus the following message types:
|
flags | Privacy flags:
|
privacyInformation | Use this object to specify which of the following headers the Unable to show "metadata-from": No such page "_space_variables" uses when sending privacy information in outgoing SIP INVITE messages:
|
transparency | Enable flag to allow ingress Privacy information to pass through unchanged.
|
Redirect
Use this object to configure Redirect parameters.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes redirect contactHandling <mergeReceivedContacts | purgeExistingContacts> flags forceRequeryForRedirection <disable | enable> honorEmbeddedHeadersin3xx <disable | enable> relayUnusedContactParams <disable | enable> skipCrankbackProfileAndAlwaysCrankback <disable | enable> mode <acceptRedirection | allowSingleRedirectAttempt | rejectRedirection | stopHunt>
Command Parameters
Redirect Parameters
Parameter | Description |
---|---|
contactHandling | Select one of the following to control processing of contacts received in SIP Redirects:
|
flags | Redirect flags:
|
| Use this object to control SIP redirection:
Note
You must use Modified: for 10.1.4 |
Parameters consumed/processed locally by the
relayUnusedContactParams
command include:- dtg
- tgrp
- trunk-context
- cic
- npdi
- npi
- rn
- bgid
- bgt
- user
- phone-context
Signaling QOS KPI Profile
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes signalingQosKpiProfile <profile_name>
Command Parameter
Signaling QOS KPI Profile Parameters
Parameter | Description |
---|---|
| The Signaling QoS KPI (Key Performance Indicator) Profile name. |
SIP Cause Mapping
Command Syntax
% set profiles signaling ipSignalingProfile <IPSP name> egressIpAttributes sipCauseMapping sipToInternalCauseMappingProfileName <sipToInternalProfile_Name> internalToSipCauseMappingProfileName <internalToSIPProfile_Name>
Command Parameters
SIP Cause Mapping Parameters
Parameter | Description |
---|---|
sipCauseMapping | Use this object in a SBC ERE configuration to create Internal-to-SIP and SIP-to-Internal SIP Cause Mapping Profile names for this IP Signaling Profile.
|
To create a profile to map CPC and SIP, refer to CPC to SIP Cause Map Profile - CLI and SIP CPC Cause Code Mapping Profiles - CLI.
To associated these profiles with Ingress/Egress trunk groups, refer to SIP Trunk Group - Signaling - CLI.
For configuration examples and external PSX considerations, refer to Configuring SIP Cause Code Mapping.
SIP Headers and Parameters
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes sipHeadersAndParameters callForwarding dataMapping <diversion | none | pkHeader> diversionHeaderTransparency <disable | enable> diversionHistoryInfoInterworking <disable | enable> historyInformation includeHistoryInformation <disable | enable> causeParameterInRFC4458 <disable | enable> reasonWithCauseValueAsPerRFC4244 <disable | enable> destinationTrunkGroupOptions <includeDtg | includeNone | includeTgrpWithDomainName | includeTgrpWithIpAddress> flags endToEndAck <disable | enable> includeCic <disable | enable> includeCpcInformation <disable | enable> includeNpi <disable | enable> includeOlip <disable | enable> includePKAdn <disable | enable> includePstnParameters <disable | enable> includeQvalue <disable | enable> skipCSeqCheckInEarlyDialog <disable | enable> transparencyForDestinationTrunkGroupParameter <disable | enable> generateCallIdUsing <doNotUseIngressCallId | useIngressCallIdByAddingStaticString | useIngressCallIdByPrepending> includeChargeInformation <includeNone | includePChargeInfo> originatingTrunkGroupOptions <includeNone | includeOtg | includeTgrpWithDomainName | includeTgrpWithIpAddress> sessionExpiresRefresher <notSend | uac | uas> sipToHeaderMapping <calledNumber | gapDialedNumber | none | originalCalledNumberOcn>
Command Parameters
sipHeadersAndParameters Parameters
Parameter | Description |
---|---|
callForwarding | This parameter is used to control the call forwarding data mapping method in egress SIP signaling.
|
destinationTrunkGroupOptions | Use this parameter to specify destination trunk group options.
|
flags | Use this object to configure the SIP Headers and Parameters flags.
|
generateCallIdUsing | Use this parameter to control ingress and egress Call-ID behavior.
|
includeChargeInformation | Select the Unable to show "metadata-from": No such page "_space_variables" ensures that the egress P-Charge-Info header in INVITE message is populated with the indicated data. If the Unable to show "metadata-from": No such page "_space_variables" receives a SIP INVITE message for a call destined to the PSTN, the Unable to show "metadata-from": No such page "_space_variables" populates the charge number parameter of the outgoing IAM based on the egress P-Charge-Info header in INVITE message.
|
originatingTrunkGroupOptions | Use this parameter to specify originating trunk group options.
|
sessionExpiresRefresher | Controls whether the refresher parameter is sent in the Session-Expires header and is enabled when the Customized Session Timer Behavior flag is selected. Options include:
|
| This parameter indicates which number is mapped and returned in the outgoing SIP To header. Options include:
|
Transport
To learn more about the various methods of controlling transport protocols for SIP signaling and how these work together, refer to Controlling SBC Core Transport Protocols for SIP Signaling.
Command Syntax
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes transport type1...type4 none sctp tcp tlsOverTcp udp
Command Parameters
Transport Parameters
Parameter | Length/Range | Description |
---|---|---|
| N/A | Use this object to set up to four transport parameter types:
|