Egress IP Attributes - SIP - CLI

By default, the SBC 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.  

• disable (default)
• enable

When useSipDomainNameInFromField is enabled, the following flags are available:

• preserveIngressFromDomainName – If a SIP domain is configured for the ingress trunk group and this flag is enabled, the default gateway associated with that SIP domain will be the originating gateway. Otherwise, the originating gateway will be the default gateway associated with the SIP domain associated with the Softswitch entity.
  • disable (default)

  • enable

• useLowerCaseDomainNames – Set flag to allow lower case domain name.
  • disable (default)

  • enable


NOTE: The above two flags only apply when a Domain Name is configured for this zone (refer to Zone - CLI).

Use this flag to indicate how to treat SIP Domain name in outgoing SIP INVITE.

• disable – The SBC includes the IP address in the host-port portion of the Request-URI in outgoing SIP INVITE messages.
• enable – The SBC includes the trunk group domain associated with egress trunk group as destination domain name in outgoing SIP INVITE messages.

When useSipDomainNameInRequestUri is enabled, the following parameters are available:

• preserveIngressRUriDomainName – Preserve Ingress R-URI Domain Name Flag. When enabled, the ERE/SBC uses domain name received in the Request-URI as destination domain name in outgoing SIP INVITE messages. Normally, outgoing SIP INVITE messages contain the trunk group domain assigned to egress trunk group.
  • disable (default)
  • enable
• useLowerCaseDomainNames – Set flag to allow lower case domain names.
  • disable (default)
  • enable

• disable (default)
• enable

• disable (default)
• enable

• disable (default)
• enable

• disable (default)
• enable

Enable flag to prevent SBC from sending an unregister message (Register=0) to the registrar upon expiration of a SIP UA registration. When disabled, the SBC generates unregister messages on the egress leg if the UA does not refresh the registration on time.

• disable (default)
• enable 

• disable (default)
• enable 

• disable (default)
• enable

When enabled, the SBC validates ISUB digits for called and calling parties. When isabled, the SBC will not validate ISUB digits.

Use this flag to decide whether to send a CANCEL immediately after getting the INVITE or wait until a 100 Trying message. When enabled, the SBC alerts the gateway initiating an INVITE that it can only send a SIP CANCEL after receiving a SIP provisional response (the SIP CANCEL must conform to RFC 3261). 

• disable (default) – When the SBC receives a cancel request from the ingress side, it sends a cancel request to the egress side at any time, even if no provisional response was received. 
• enable – The SBC sends a CANCEL to the egress side after receiving a provisional response, such as 100 or 18x. 

Enable flag to prevent the SBC 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 SBC and ERE SIP proxy/redirector send "rn=NNNN" in the userinfo portion of the Request URI, where "NNNN" is the LNP translated number.

• disable (default)
• enable

Use the following options to specify whether the SBC 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.

• doNotIncludeNpdi – Do not send the NPDI parameter.
• includeNpdi – Send "npdi" in the userinfo portion of the Request URI.
• includeNpdiYes – (default) Send "npdi=yes" in the userinfo portion of the Request URI.

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 SBC. The SBC uses this configured value to insert phone-context parameter of received length in RURI and To headers.

When the flag is set to enable, the SBC anonymizes the incoming host IP portion of the private headers (P-AID, P-PID, RPID) by replacing it with the IP address of the SBC before sending it to the egress leg of a call.

• disable (default)
• enable

Note: This flag is available for configuration only when the transparency flag (below) is enabled. For more information on Privacy Transparency of Egress IP Attributes, see Privacy section.

This feature supports in-dialog messages only, plus the following message types:

• INVITE
• BYE
• OPTIONS
• SUBSCRIBE
• NOTIFY
• UPDATE
• PUBLISH
• MESSAGE

Privacy flags:

• includeEmbeddedPaiHeaderInRedirectedInvite – Enable this flag to include the embedded PAI header in the redirected Invite message.
  • disable (default)
  • enable
• includePrivacy – Use this flag to specify whether the SBC includes privacy information in outgoing SIP INVITE messages.
  • disable – The SBC does not include a P-Preferred-Identity header or a P-Asserted-Identity header, an Anonymous identifier in the SIP From field, or a Privacy header that contains a Critical token in outgoing SIP INVITE messages, and the SBC will not include a P-Asserted-Identity header or a Privacy header that contains a Critical token in outgoing SIP INVITE messages.
  • enable (default) – The SBC includes either a P-Preferred- Identity header or a P-Asserted-Identity header (provisioned in Privacy Information above) in outgoing SIP INVITE messages. The SBC will include a P-Asserted-Identity header in outgoing SIP INVITE messages. The SBC will also insert an Anonymous identifier in the SIP From field and the SBC will include a Privacy header that contains a Critical token.
• msLyncPrivacySupport – Backward compatibility for the Caller Privacy feature. The Caller privacy feature only works if this flag is enabled.
  • disable (default)
  • enable
• privacyRequiredByProxy – Enable flag to indicate that privacy service is mandated for any calls to the SIP trunk (proxy). In this case, the SBC includes a Proxy-Require header with a privacy value, and a critical token in the Privacy header of the INVITE message. The privacy service must be applied by the proxy or the call is rejected. If disabled, the SBC does not include a Proxy-Require header with privacy value. The proxy accepts the call even if it cannot provide privacy service.
  • disable (default)
  • enable

Use this object to specify which of the following headers the SBC uses when sending privacy information in outgoing SIP INVITE messages:

• pAssertedId – Used among trusted SIP entities (typically intermediaries) to carry the identity of the caller as it was verified by authentication.
• pPreferredId – Used by a User Agent (UA) to carry the identity the caller wishes to be used, and sent to a trusted proxy to be inserted in the P-Asserted-Identity field.
• remotePartyId – Used among trusted SIP entities (typically intermediaries) to carry the identity of the caller as it was verified by authentication. This header is specified in an earlier RFC that continues to be supported.

Redirect flags:

• forceRequeryForRedirection – (applies to Invite requests only) Use flag to re-query ERE with contact information received in a 3xx response for redirection-type scenarios.
  • disable (default)

  • enable
    

    To use this feature, you must also use the SIP Trunk Group Services parameter "maxRouteAttempts" and choose the redirect mode "stopHunt".

     

• honorEmbeddedHeadersin3xx – Enable flag to allow the processing of embedded headers in 3xx Contact headers for the trunk group that received the 3xx.

  • disable (default)
  • enable
    
• relayUnusedContactParams – When enabled, Contact parameters received in 3xx responses that are not consumed/processed locally by the SBC (see NOTE below) can now be passed through to the R-URI of subsequent INVITE request.
• • disable (default)
  • enable 
• skipCrankbackProfileAndAlwaysCrankback – Enable this flag to force any 4xx–6xx SIP response code to cause crankback so the next potential contact or 3xx response is tried. If disabled, only the response codes specified in default SBC crankback profile cause the call to crank back.
  • disable (default)
  • enable

Use this object to control SIP redirection:

• acceptRedirection (default) – Multiple redirections are allowed.
• allowSingleRedirectAttempt – Only a single Redirect is allowed per route. Additional Redirects cause crankback to be performed.
• rejectRedirection – If a Redirect is received, crank back is performed.

• stopHunt – Prevent call attempts on subsequent trunk groups if 3xx is received following an Invite and the SBC fails to establish the call with all the contacts from 3xx.
  

  Note

  You must use stopHunt in conjunction with the egress IP Signaling Profile redirect flag forceRequeryForRedirection.

This parameter is used to control the call forwarding data mapping method in egress SIP signaling.

• dataMapping – Use this parameter to define how to map the diversion or redirecting data. Options are:
  • none – No Diversion information is egressed.

  • diversion – Diversion information is sent out as SIP Diversion Header.

  • pkHeaders – Diversion information is sent out as proprietary PK Headers.

• diversionHeaderTransparency – When enabled, the ingress Diversion header is passed through unchanged. Call forwarding data mapping transparency applies to Diversion header only
  • disable (default)
  • enable
• diversionHistoryInfoInterworking – Enable flag to allow interworking between Diversion and History-Info header as per RFC 6044. The SBC supports up to 12 History-Info entries and 10 Diversion entries. When this flag is disabled, only the first and last entries are maintained when History-Info or diversion transparency is disabled.
  
  • disable (default)
  • enable
    NOTE: This flag is only visible when either Diversion or History-Info header is selected as the egress call-forwarding header. Diversion and History-Info Transparency configuration controls are ignored when it is enabled. This parameter has precedence over these controls, as well as the TG Signaling flag acceptHistoryInfo.

• historyInformation includeHistoryInformation – Use this parameter to specify how to treat call forwarding history information. Enable this flag to include History-Info in INVITE egress message.
  
  • disable (default)
  • enable

  • causeParameterInRFC4458 – Enable this flag to include the History-Info cause value in egress message as per RFC 4458 recommendation. When the flag is enabled, the output is similar to the following example:
    History-Info: <sip:1234567890@P1.interwork.com?Privacy=none>;index=1, <sip: last_diverting_target;cause=408>;index=1.1
    
    • disable (default)
    • enable
  • reasonWithCauseValueAsPerRFC4244 – Enable this flag to include History-Info cause value with Reason Header as per RFC 4244 recommendation. When the flag is enabled, the output is similar to the following example:
    History-Info: <sip:1234567890@P1.interwork.com?Privacy=none>;index=1, <sip: last_diverting_target?Reason=SIP%3Bcause%3D408>;index=1.1
    
    • disable (default)
    • enable
  • supportRFC7044 – Enable this flag to set the History-Info header's behavior in accordance with RFC-7044.
    • disable (default)
    • enable
  • applyHistoryInfoPrivacy – Enable this flag to anonymize the History-Info header.
    • disable (default)
    • enable

Use this object to configure the SIP Headers and Parameters flags.

• endToEndAck – Enable flag to send the ACK towards egress for the initial invite after receiving it from the ingress (remote) entity. The application retransmits the 200 OK towards the ingress side based on the configuration, and terminates the call if no ACK is received for the corresponding 200 OK.
  • disable (default)
  • enable
• includeCic – If enabled, the SBC includes the Carrier Identification Code in a cic= parameter in outgoing INVITE messages.
  • disable (default)
  • enabl
• includeCpcInformation – If enabled, the SBC includes the Calling Party Category (CPC) parameter value in the From header of outgoing SIP INVITE messages.The CPC parameter characterizes the station used to originate a call, such as ordinary, priority, data, test, operator, pay phone, prison, hotel or unknown.
  • disable (default)
  • enable

• includeNpi – If enabled, the SBC includes the Numbering Plan Indicator in a npi= parameter in outgoing INVITE messages.
  • disable (default)
  • enable
• includeOlip – If enabled, the SBC includes the Originating Line Information Parameter in a oli= parameter in outgoing INVITE messages.
  • disable (default)
  • enable
• includePKAdn – When enabled, the SBC includes the P-K-Adn header in egress SIP messages. When disabled, the SBC does not include the P-K-Adn header. The P-K-Adn header is a customer-specific SIP header used for ISUP-to-SIP interworking and contains the Translation Source Number (TSN) used in Number to SIP URL translation via the Number Username Translation screen (Generic variant only).
  • disable (default)
  • enable
• includePstnParameters – If enabled, the SBC includes a set of specific PSTN parameters in a pstn-params= entry in outgoing INVITE messages. The PSTN parameters currently included in pstn-params are Screening Indicator, ISDN Indicator, and Transmission Medium Requirement (TMR).
  • disable (default)
  • enable
• includeQvalue – If enabled, the ERE SIP proxy/redirector includes the qvalue parameter (for example, q=0.9) in the Contact header of outgoing 3xx messages.
  • disable (default)
  • enable
• skipCSeqCheckInEarlyDialog – When enabled, the SBC accepts multiple SIP requests in which the CSeq number in a later request is of a lesser value than the CSeq number received in earlier requests.
  • disable (default)
  • enable
• transparencyForDestinationTrunkGroupParameter – When enabled, if ERE receives both tgrp parameter and trunk-context in an ingress INVITE Request-URI, ERE as proxy transparently passes the tgrp parameter and trunk-context in the egress INVITE Request-URI. Values selected for the "Destination Trunk Group Option" are ignored.
  • disable (default)
  • enable

Select the includePChargeInfo option to map charge information in a call setup message (i.e., the charge number parameter of an IAM) to egress P-Charge-Info header in INVITE message. If the ERE returns billing information in a policy response, the SBC ensures that the egress P-Charge-Info header in INVITE message is populated with the indicated data. If the SBC receives a SIP INVITE message for a call destined to the PSTN, the SBC populates the charge number parameter of the outgoing IAM based on the egress P-Charge-Info header in INVITE message.

• includeNone (default)
• includePChargeInfo