Skip to end of metadata
Go to start of metadata

The SBC Core includes a configurable Transparency Profile capable of transparently passing SIP headers and SIP message bodies.

This example configuration describes how to create and configure a transparency profile to transparently pass headers and message bodies using the following basic steps:

Though these steps can be performed from either the EMA or from the CLI, the description below is limited to CLI. 

IMPORTANT

The Transparency Profile is the recommended method of configuring transparency on the SBC Core for new deployments as well as when 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.

 

1. Creating a Transparency Profile

Enter the following commands to create a transparency profile.

set profiles services transparencyProfile testProfile
commit

2. Configuring Headers and/or Message Bodies in Transparency Profile

Perform the following steps to configure headers and/or message bodies in your transparency profile.

2.1 Configure Headers

  1. Configure Transparency of "all" Headers.

    set profiles services transparencyProfile testProfile sipHeader all
    commit
  2. Configure Transparency of a specific Header with Per-Method Exclusion.

    set profiles services transparencyProfile testProfile sipHeader contact excludedMethods info, notify
    commit
  3. Configure Selective Exclusion of Transparency of Headers.

    set profiles services transparencyProfile testProfile sipHeader contact ignoreTransparency yes 
    commit

Note

If a specific header is being configured, ignoreTransparency and excludedMethods are exclusive. If ignoreTransparency is configured, excludedMethods will not display subsequently. If excludedMethods is configured, ignoreTransparency will not display.

The ignoreTransparency configurable applies in the following cases:

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

2.2 Configure Message Bodies

Info

Rules must be configured in the Transparency Profile for the types of content that must be transparently passed through. These rules can be categorized as follows based on the SBC action to take:

  • Rules to allow select types of content through
    • allow any SIP method (of the SIP message) the content may appear in to pass
    • allow any SIP method except certain select methods to pass
  • Rules to disallow select types of content from being transparently passed through

 

  1. Allow a specific type of content through.

    set profiles services transparencyProfile testProfile sipMessageBody application/foo
    commit

    Note

    This rule does not apply when combined with a rule to allow all types of content. To start out allowing all types of content through, and then excluding specific content, skip to step 2.
  2. Allow all types of content through.

    set profiles services transparencyProfile testProfile sipMessageBody all
    commit
  3. Allow all types of content through in all SIP messages except select SIP methods.

    set profiles services transparencyProfile testProfile sipMessageBody all excludedMethods info,invite 
    commit
  4. Allow a specific message body through in all SIP messages except certain select methods.

    set profiles services transparencyProfile testProfile sipMessageBody application/foo excludedMethods info,invite
    commit
  5. Disallow a message body from being transparently passed through.

    set profiles services transparencyProfile testProfile sipMessageBody application/foo ignoreTransparency yes
    commit

    Note

    This rule only applies in the following cases:

    1. when combined with a rule to allow all types of content
    2. when one of the transparency flags for message bodies in the IP Signaling Profile is enabled

3. Attaching a Transparency Profile to a Trunk Group

Enter the following commands to attach a transparency profile to a trunk group:

set addressContext testAC zone testZone sipTrunkGroup testTG services transparencyProfile testProfile
commit

4. Enabling a Transparency Profile

To enable a Transparency Profile, enter the following commands:

set profiles services transparencyProfile testProfile state enabled
commit

5. Viewing Transparency Profile

To view the currently configured transparency profiles, enter the following 'show' command:

show profiles services transparencyProfile

Example:

Example
show profiles services transparencyProfile
transparencyProfile test {
    sipHeader all;
    sipMessageBody all;
    sipMessageBody application/foo {
        ignoreTransparency yes;
    }
    sipMessageBody application/new {
        excludedMethods invite,info;
    }
}

Appendix A. Detaching a Transparency Profile From a Trunk Group

Enter the following commands to detach a transparency profile from a trunk group:

delete addressContext testAC zone testZone sipTrunkGroup testTG services transparencyProfile 
commit

Appendix B. Removing a Transparency Profile

The state of the transparency profile must be disabled before any modification or deletion of the transparency profile can be made. See example below:

set profiles services transparencyProfile testProfile state disabled
commit

delete profiles services transparencyProfile testProfile
commit