You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Back to Table of Contents

Back to CLI Configure Mode

Back to Profiles - CLI

Back to Services - CLI

In this section:

 Related articles:

 


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

Headers may be configured in compact form and transparently passed using a Transparency Profile. It is advisable to configure both compact and long formats to ensure both types of received headers in the PDU are transparently passed.

 

Command Syntax

The CLI syntax to configure a Transparency Profile is shown below:

% set profiles services transparencyProfile <tpName>
	sipHeader <name of SIP header, or 'all'>
		excludedMethods <bye | info | invite | message | notify | options | publish | refer | register | subscribe | update>
		ignoreTransparency <no | yes> 
	sipMessageBody <content-type, or 'all'>
		excludedMethods <bye | info | invite | message | notify | options | publish | refer | register | subscribe | update>
		ignoreTransparency <no | yes>
	state <disabled | enabled>

 

The CLI syntax to assign the Transparency Profile to an egress Trunk Group is shown below:

% set addressContext <addressContextName> zone <zoneName> sipTrunkGroup <trunkGroupsName> services transparencyProfile <tpName>

Command Parameters

Transparency Profile Parameters

 
ParameterLength/RangeDescription
transparencyProfile1-23 characters

<Transparency Profile name> – This profile contains a list of SIP headers and/or SIP message bodies to pass transparently. Enter a name for the profile

sipHeader1-31 characters

<SIP header name, or 'all'> – Enter the name of SIP header to transparently pass, or enter 'all' to transparently pass all SIP headers.

  • excludedMethods – Enter method(s) to exclude from this Transparency Profile configuration.
    <bye | info | invite | message | notify | options | publish | refer | register | subscribe | update>
  • ignoreTransparency – Set to 'yes' to ignore transparency for this Transparency Profile configuration.
    • no (default)
    • yes

Note

If a specific header is configured, ignoreTransparency and excludedMethods are exclusive. Once ignoreTransparency is configured, excludedMethods no longer displays. Likewise, once excludedMethods is configured, ignoreTransparency no longer displays.

Note

The ignoreTransparency flag applies in the following scenarios:

  • when combined with a configuration to allow all SIP headers
    -or-
  • when one of the SIP header transparency flags is enabled in the IP Signaling Profile
sipMessageBody 1-127 characters

<content-type, or 'all'> – Enter the name of the content-type to transparently pass, or enter 'all' to transparently pass all SIP message body types. The value used for content-type must match the actual content type received in the SIP request or response (e.g. application/dialog-info+xml).

  • excludedMethods – Enter method(s) to exclude from this Transparency Profile configuration.
    <bye | info | invite | message | notify | options | publish | refer | register | subscribe | update>
  • ignoreTransparency – Set to 'yes' to not pass through the specified content-type defined within the Transparency Profile configuration.
    • no (default)
    • yes

 

Note

The ignoreTransparency flag applies in the following scenarios:

  • when combined with a configuration to allow all types of content
    -or-
  • when one of the SIP message body transparency flags is enabled in the IP Signaling Profile

 

Note

Setting sipMessageBody to "all” in a Transparency Profile transparently passes all unknown bodies. To ignore a specific body, add the respective message body to the Transparency Profile and set ignoreTransparency to "yes". Refer to SBC SIP Transparency Implementation Guide for examples.


stateN/A

Enable this flag to use this Transparency Profile.

  • disabled (default)
  • enabled

Command Examples

Info

To see a step-by-step configuration example, see Configuring a Transparency Profile.

To configure transparency of all headers for a Transparency Profile and view the results:

% set profiles services transparencyProfile TP_E sipHeader all
% commit

% show profiles services transparencyProfile TP_E
state enabled;
sipHeader all;

To exclude select methods from a SIP header:

% set profiles services transparencyProfile TP_F sipHeader SH1 excludedMethods invite,info,register

 

To exclude transparency for a specific SIP header:

% set profiles services transparencyProfile TP_G sipHeader SH1 ignoreTransparency yes

 

To assign transparency profile to a trunk group:

% set addressContext ADDR_CONTEXT_1 zone ZONE_AS sipTrunkGroup TG_ASX_MERCURY services transparencyProfile TP_E

 

To allow a specific type of content through:

% set profiles services transparencyProfile testProfile sipMessageBody application/foo

 

To allow all types of content through in all SIP messages except certain select SIP methods:

% set profiles services transparencyProfile testProfile sipMessageBody all excludedMethods info,invite

  • No labels