DO NOT SHARE THESE DOCS WITH CUSTOMERS!
This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.
In this section:
The SIP Adaptor Profile object is the main construct for SIP Message Manipulation (SMM) functionality. Using SMM criteria and actions, you define SMM rules within a SIP Adaptor Profile. The SBC applies the profile to SIP messages in order to modify their headers and/or parameters. When a message comes into or out of the SBC and a SIP Adaptor Profile applies, the message is evaluated based on the set of criteria in the profile. If the message meets the criteria, it is modified according to actions defined in the profile. You can assign SMM profiles at the global, address context, zone, and SIP trunk group levels. You have the option to define profiles at any or all of these levels. Refer to SIP Message Manipulation for more information on SMM. For SIP Adaptor Profile provisioning limits, refer to SBC Provisioning Limits.
The number of rules in a profile is limited to 10,000 and the number of actions across profiles in a system is limited to 50,000.
Ensure the above conditions are met before LSWU.
A SIP adapter profile can also be configured to support a flexible policy mechanism to facilitate dynamic routing and policy decisions based on any SIP message information element whereby routing and policy selection criteria are provisioned by the operator. An information element can be anything in the message, such as the following examples:
The following objects are used in supporting flexible policy and routing.
The Profile Type
parameter is used to specify whether a SIP adapter profile is used for flexible policy or message manipulation (default).
The System Provisioning - Zone object is used to assign a flexible policy-specific SIP adapter profile to a specific zone.
The Trunk Group - SIP Trunk Group object is used to assign a flexible policy-specific SIP adapter profile to a specific trunk group.
For Flexible Policy and Routing feature implementation, refer to Flexible Policy and Routing Support.
For Flexible Policy and Routing best practices, refer to Configuring Dynamic Policies and Routing Using Flexible Policy and Routing Feature.
The following general SIP Message Manipulation (SMM) rules apply when creating or editing SIP adapter profile.
SIP Adaptor Profile SMM Rules
Category | Rules |
---|---|
Profile | To edit/modify a profile, you must disable the profile first to make the necessary modifications and then enable it. |
Profile Type | To specify whether a SIP adapter profile is to be used for flexible policy or message manipulation. |
Rule |
|
Criteria |
|
Actions |
|
To create and work with SIP adapter profiles, go to Configuration > System Provisioning > Category: Trunk Provisioning > SIP Adaptor (SMM) Profile or
All > Profiles > Signaling > SIP Adaptor Profile
The SIP Adaptor Profile window opens with any existing profiles listed.
SIP Adaptor Profile Window
The following tool options are offered across the top of the window:
Except for the New SIP Adaptor Profile option, you must select a profile from the list to make the tool options available. Each tool opens in its own form on the window. More than one tool may be open at the same time.
To minimize a form, click the "-" symbol in the top left corner. To maximize it, click the "+" symbol. Click the "x" symbol to close the form.
In the SIP Adaptor Profile List, the delete option (X) is only available when the profile is disabled.
Click New SIP Adaptor Profile to begin creating a new SIP adapter profile. The Create New SIP Adaptor Profile form opens.
Create New SIP Adaptor Profile Form
The Create New SIP Adaptor Profile form consists of four sections:
Required fields are designated with an asterisk next to the field.
When you define criteria and action statements, it is quite common that when you make a selection, a new selection appears for you to define. For example, when defining a Message criteria and you choose "all response messages" in the for field, the field "with a response code" will appear with the choices "of" and "in the range". Selecting "of" then causes a blank field to appear for you to define the response code.
While creating or editing a SIP adapter profile, periodically click Save to save your progress.
Use the following table to define the Criteria and Action fields for rule 1 in the profile. For each rule, you can define one or more criteria, and one or more actions. Click Save to save the rule and add the profile to the SIP Adaptor Profile List.
Rules Form Fields
Field/Control | Description |
---|---|
Name | Enter the SIP adapter profile name. The length of the SIP adapter profile name can be up to 23 characters. |
Profile Type | When creating a SIP adapter profile, use this parameter to specify whether a SIP adapter profile is to be used for flexible policy or message manipulation.
|
Criteria: | |
Type | Each criteria you define will include one or more criteria types. By default, the first criteria type is Message, so the minimum activity to define is to take an action against one or more messages. Criteria Types include:
|
Sub-fields | Type: Message
Type: Header
Type: Parameter
Type: Token
Type: Variable
Type: Global Variable
Type: Message Body
|
(additional fields) | Additional fields will display to define request or response message types for the above two choices designated by "*". |
Undo Button | Click to undo your current edits and start over defining criteria. |
Add Criterion Button | Click to add the criterion to the rule. The criterion displays in its final definition. To re-edit the criterion, click the Edit button, make the change, and click Apply Edit button. |
Action: | |
Default action | The default action is to "Apply actions to a specific header instance equal to header instance 1. Click the edit tool (pencil icon) to change among:
|
Type | Type defines the portion of the message on which the action is taken. Types include:
|
action sub-field | The type selected will determine the list of available actions. For example, the following list of actions appear for the Header type:
The Parameter type includes:
The Token type includes:
The Message Body type includes:
The Variable type includes:
The Message type includes:
Some actions include use of regular expressions as described below: Regular expressions are based on the following W3C regular expressions pattern which is defined as a pattern, or sub-pattern, containing any white space or none white space string for up to 128 characters. The pattern can occur zero or one time. "(((([\s\S])){0,128})){0,1}" |
additional sub-fields | One or more additional fields can display to further define the action to take depending upon the action chosen in the field above. For example, selecting Type "Parameter" and action "add a parameter" will produce three additional fields to be completed:
Or, selecting Type "Message" and action "teardown the dialog" produces the following field to specify a numeric SIP response code:
Or, selecting Type "Message" and action "Route Action on Crankback" will open a list with three possible choices of action:
|
Footer | |
Enabled | Click to enable this profile. A profile must be disabled to be deleted. |
Advanced SMM Enabled | Enable flag to apply advanced SMM logic, such as dialog stateful variables, to the following messaging:
NOTE: Dialog Stateful variables are not applied for the NOTIFY messages received prior to receiving 200 OK response to the Egress SUBSCRIBE. For an example SMM rule, see How to Treat Hostpart Based on the Received Format. |
You can modify the SMM rules on a live system when SMM rules are being applied. The existing rules continue to be applied. The new rules become active once committed.
Click Edit Rule Sequence.
Edit Rule Sequence Form
You can assign a selected SMM profile at the global, address context, zone, and SIP trunk group levels. You can assign a selected Flexible Policy profile at the SIP trunk group and zone levels.
Click Assign SIP Adaptor Profile. Depending on the profile type, either a Message Manipulation or Flexible Policy form opens.
Assign SIP Adaptor Profile - Message Manipulation
Assign SIP Adaptor Profile - Flexible Policy
Select the SIP Adaptor profile you want to test from the SIP Adaptor Profile List.
Click Test SIP Adaptor Profile. Test SIP Adaptor Profile tool displays in the workspace.
SIP Adaptor Profile Test Tool
In Global Variable Values, enter any optional environment variables you want to apply during the test. Use the following formats:
Field | Convention |
---|---|
Source IP Address | IPv4 or IPv6 formatted IP address |
Source Port | Integer in the range of 0..4294967295 |
Signaling Port ID | Integer in the range of 0..4294967295 |
Local IP Address | IPv4 or IPv6 formatted IP address |
Local Port | Integer in the range of 0..4294967295 |
Egress Trunk Group Name | 1-23 characters (characters allowed: +-.:@0-9A-Z_a-z) |
Ingress Trunk Group Name | 1-23 characters (characters allowed: +-.:@0-9A-Z_a-z) |
Copy the SIP message you want to test from a browser or other source, and the paste it into the Input SIP Message window.
Input SIP Message
Click Test. The Selected SIP Adaptor Profile is applied to the SIP message, and the results are display in Output SIP Message. An example appears below.
Test SIP Adaptor Profile Tool
View CLI Script Tool
The following example uses a SIP Adaptor Profile to store a SIP trunk group name. The SBC Core provides interworking functionality between the call legs when only one leg of a call supports preconditions while the other leg does not. Preconditions interworking is triggered based on the presence/absence or value of a SIP information element (for example, a proprietary header or parameter). The message content is based on IP Trunk Group (IPTG)-related configurables on the ingress leg.
NOTE: During an ingress precondition interworking scenario, if the remote precondition is met in PRACK, the SBC processes it and sends the INVITE towards the egress.
Prior to configuring a SIP Trunk Group name to a variable, refer to Reserving Network Resources to understand the preconditions and the requirements.
Follow these steps to assign a SIP trunk group name to a variable:
Click to enable its State. The other parameters/flags become available.
Ip Signaling Profile - Preconditions
Navigate to Configuration > System Provisioning > Category: Trunk Provisioning > SIP Adaptor (SMM) Profile. The SIP Adaptor (SMM) Profile window is displayed.
Store IP TG