egressIpAttributes - SIP - CLI

bci

N/A

Use this object to configure Backward Call Indicator (BCI) for Egress IP attributes.

• bciInterworkEncountered – Enable flag to indicate that ISUP is interworking with a network which is not capable of providing as many services as ISUP does. ISUP networks will therefore not employ certain features they otherwise normally would, including potentially the use of ISDN cause codes in failure conditions .
  • disable (default)
  • enable
• bciIsdnAddess – Enable flag to enable ISDN Address in the BCI parameter of backward SS7 messages (e.g. ACM or ANM).
  • disable (default)
  • enable

domainName

N/A

Use this object to specify use of domain names. For parameter details see domainName Parameters table below.

flags

N/A

Use this object to set egress IP attribute flags.

• 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.
  • disable (default)
  • enable
• 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.
  • disable (default)

  • enable

• disable2806Compliance – If enabled, the 2806 Compliance Code is disabled and no phone context or user=phone parameters are signaled in egress messages.
  • disable (default)
  • enable
• 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.
  • disable (default)
  • enable
• ignoreSdpAfterOfferAnswerCompleted – 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).
  
  • disable (default)
  • enable
• includeEnumParameters – Use this flag to specify how to handle ENUM parameters in outgoing INVITE.
  • disabled (default) – SBC drops ENUM parameters received from ENUM server.
  • enabled – SBC sends ENUM parameters in the outgoing INVITE.

• 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.
  • disable (default)
  • enable
• 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.
  • disable (default)
  • enable
• qosBasedRouting – Enable flag to allow QoS-based routing.
• disable (default)
• enable
• 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.
  • disable (default)

  • enable

• 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.
  • disable (default)
  • enable
• 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.
  • disable (default)
  • enable
• 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.
  • disable (default)
  • enable
• 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.
  • disable (default)
  • enable
• validateIsubAddress – When enabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  validates ISUB digits for called and calling parties. When disabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  will not validate ISUB digits.

isub

N/A

Use this object to configure ISDN Calling Party Subaddress (ISUB) parameters:

• allowNsapIsub – Enable to allow NSAP ISUB parameter.
  • disable (default)
  • enable
• allowUserSpecifiedIsub – Allow user-specified ISUB.
  • disable (default)
  • enable
• includeCalledPartyIsub – Include called party ISUB.
  • disable (default)
  • enable
• includeCallingPartyIsub – Include calling party ISUB.
  • disable (default)
  • enable

mediaQosKpiProfile

N/A

The Media QoS KPI (Key Performance Indicator) Profile name.

numberGlobalizationProfile

N/A

The Number Globalize Profile name. This profile converts numbers to SIP global number format.

numberPortabilityAttributes

N/A

Number portability attributes configuration.

• 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.
  • disable (default)
  • enable
• 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.
• 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 parameter to configure egress P-Charge-Info header in INVITE message behavior.

• includeNOA – Enable flag to include Nature of Address Indicator in egress P-Charge-Info header in INVITE message.
  
  • disable (default)
  • enable
• includeNPI – Enable flag to include Number Plan Indicator in egress P-Charge-Info header in INVITE message.
  
  • disable
  • enable (default)
• pChargeInfoTransparency – Enable flag to transparently pass egress P-Charge-Info header in INVITE message.
  
  • disable (default)
  • enable

• pChargeInfoType – The format types for which NPI/NOA are encoded in P-Charge-Info header. Options include:
  
  • headerParameter – NPI and NOA are sent in header parameter format. For example, P-Charge-Info: <sip:123456@10.54.69.140>;npi=ISDN;noa=3
  • uriParameter (default) – NPI and NOA are sent in uri parameter format. For example, P-Charge-Info: sip:123456@10.54.69.144;npi=ISDN;noa=3
  • userParameter – NPI and NOA are sent in user info parameter format. For example, P-Charge-Info: <sip:12345;npi=ISDN;noa=3@10.54.69.144>

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

privacy

N/A

Specifies the privacy parameters.

• 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 
      Unable to show "metadata-from": No such page "_space_variables"
      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 
      Unable to show "metadata-from": No such page "_space_variables"
      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 
      Unable to show "metadata-from": No such page "_space_variables"
      includes either a P-Preferred- Identity header or a P-Asserted-Identity header (provisioned in Privacy Information above) in outgoing SIP INVITE messages. The 
      Unable to show "metadata-from": No such page "_space_variables"
      will include a P-Asserted-Identity header in outgoing SIP INVITE messages. The 
      Unable to show "metadata-from": No such page "_space_variables"
      will also insert an Anonymous identifier in the SIP From field and the 
      Unable to show "metadata-from": No such page "_space_variables"
      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 
    Unable to show "metadata-from": No such page "_space_variables"
    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 
    Unable to show "metadata-from": No such page "_space_variables"
    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
• 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:
  • 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.
• transparency – Enable flag to allow ingress Privacy information to pass through unchanged.
  • disable (default)
  • enable

redirect

N/A

Specifies the redirect parameters.

• contactHandling – Select one of the following to control processing of contacts received in SIP Redirects:
  • mergeReceivedContacts – Contacts received in Redirects are ordered by q-value and inserted at the head of the list of untried contacts.
  • purgeExistingContacts – Contacts received in Redirects are ordered by q-value and replace untried contacts.
• 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
  • 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
  • mode – 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.

signalingQosKpiProfile

N/A

The Signaling QoS KPI (Key Performance Indicator) Profile name.

sipHeadersAndParameters

N/A

Specifies the SIP header parameters. See sipHeadersAndParameters Parameters table below for parameter details.

transport

N/A

Use this object to set up to four transport parameter types:

• type1
• type2
• type3 
• type4

Each transport type above can be set to any one of the following transport protocols:

• none (default)
• sctp
• tcp
• tlsOverTcp
• udp

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 
  Unable to show "metadata-from": No such page "_space_variables"
  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

• 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

Use this parameter to specify destination trunk group options.

• includeDtg – Include the destination trunk group parameter in SIP headers sent over associated trunk group.
• includeNone (default) – Do not include any trunk group information.
• includeTgrpWithDomainName – Include trunk group with domain name.
• includeTgrpWithIpAddress – Include the destination trunk group, and include the trunk context as domain name.

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 
  Unable to show "metadata-from": No such page "_space_variables"
  includes the Carrier Identification Code in a cic= parameter in outgoing INVITE messages.
  • disable (default)
  • enable
• includeCpcInformation – If enabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  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 
  Unable to show "metadata-from": No such page "_space_variables"
  includes the Numbering Plan Indicator in a npi= parameter in outgoing INVITE messages.
  • disable (default)
  • enable
• includeOlip – If enabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  includes the Originating Line Information Parameter in a oli= parameter in outgoing INVITE messages.
  • disable (default)
  • enable
• includePKAdn – When enabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  includes the P-K-Adn header in egress SIP messages. When disabled, the 
  Unable to show "metadata-from": No such page "_space_variables"
  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 
  Unable to show "metadata-from": No such page "_space_variables"
  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 
  Unable to show "metadata-from": No such page "_space_variables"
  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

Use this parameter to control ingress and egress Call-ID behavior.

• doNotUseIngressCallId – Generates egress Call-ID independent of ingress Call-ID.
• useIngressCallIdByAddingStaticString – Generates egress Call-ID using ingress Call-ID and a static string (egressCallIdStaticString) configured in the SIP trunk group.
  Egress Call-ID is the aggregate of ingress Call-ID and static string.
• useIngressCallIdByPrepending – Generates egress Call-ID using ingress Call-ID and locally generated string. Egress Call-ID is the aggregate of ingress Call-ID and locally generated string.

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 

• includeNone (default)
• includePChargeInfo

Use this parameter to specify originating trunk group options.

• includeNone (default) – Do not include any trunk group information.
• includeOtg – Include the originating trunk group parameter in SIP headers sent over the associated trunk group.
• includeTgrpWithDomainName – Include the originating trunk group, and include the trunk context as domain name.
• includeTgrpWithIpAddress – Include the originating trunk group, and include the trunk context as IP address

sipToHeaderMapping

This parameter indicates which number is mapped and returned in the outgoing SIP To header. Options include:

• calledNumber – The TO header is mapped using the called number.
• gapDialedNumber – The TO header is mapped using the Generic Address Parameter from mime, if applicable.
• none (default) – The TO header user part is mapped from the Original Called Number, if present. Otherwise, it is mapped from the Called Number. The Original Called Number may be taken from the Diversion or the History-Info header, if present, in a SIP Invite.
• originalCalledNumberOcn – The TO header is mapped using the redirecting original Called number OCN parameter. This is filled from the SIP Invite using the Diversion or the History-Info header, if present.