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:
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.
Each SIP Adaptor Profile can contain up to 10,000 rules that are applied sequentially to messages. Each rule can have up to 20 criteria and up to 128 actions. The SIP Message Manipulation (SMM) rule processing inspects each SIP message and looks for a matches with its defined criteria. If all the criteria are met, SMM applies its defined action(s) to the message and sends the message for further processing.
Rules within a profile are applied to messages sequentially in the order of the rule index numbers.
Each rule consists of two main parts:
Criteria includes the conditions required to execute the rules. Actions specify the actual modifications to perform.
Do not use SMM to manipulate To, From, Contact and Request URIs in incoming REGISTER messages.
For an OPTIONS ping that the SBC generates for Pathcheck, apply the SMM only at the Global level. If the SMM is attached at Zone, TG, or AddressContext, the rules are not applied. Refer to Signaling - Global - CLI for applying SMM profiles (SIP adaptor profiles) at the global level.
The SBC uses GNU Extended Regular Expressions character sets, which does not support the characters "\d" and "\D". Ribbon recommends not using "\d" and "\D" in the regular expressions of SMM rule criteria. As an alternative, use the [0-9] format.
Rules are logically grouped into the following categories.
As rules are defined, some headers or parameters may be unknown to the SBC (for example, a rule to remove a proprietary header). In such cases, even though the SBC does not have any information about the type of header or parameter, it can still refer to the tokens in these constructs.
It is assumed that if a rule refers to a userpart or hostpart, the corresponding header or parameter is in URL format.
The SBC supports modifying SMM rules on a live system. SBC users can edit or update the SMM rules in a SIP Adaptor profile without changing the admin state. The existing rules continue to exist and new rules are active once confirmed or applied.
SMM provides functionality to compare two variables. The criterion values, variables-equal
and variables-not-equal
, determine:
Five CDR fields of 256 bytes each are provided to log proprietary information in accounting records using SMM rules:
These fields are present in SIP Specific Protocol string of the START, STOP, INTERMEDIATE, and ATTEMPT records for session-based accounting.
The value of the above SMM CDR fields can store:
The SBC supports generating and sending PRACK messages internally and sending PRACK messages back to the IAD if an incoming 18x with 100Rel is dropped.
Feature limitations:
The SBC uses SMM to manipulate SDP using regular expressions.
You must use CLI commands; there is no EMA support for Native SDP Manipulation.
You can create SMM rules to directly manipulate SDP using the following operations:
Use the ADD operation to:
Use the DELETE operation to:
Use the GET operation to store the:
Use the STORE operation to store:
Use the FILTER-CODEC operation to filter or re-arrange the codecs in a particular media stream. The From operand value represents the codec pattern being applied for the filtering. The pattern can contain up to 25 comma-separated codec names, or the wildcard codec "*". Do not use more than one wildcard "*" codec in the codec pattern.
Limitations:
Use the CONDITION EXIST Criterion option to:
The SBC is able to reduce the usage of SMM rules significantly using switch semantics. To support this functionality, the object switch
can be added to the sipAdaptorProfile
. When a value or a regular expression string matches a defined SMM rule, the corresponding action is performed. Switch semantics are applicable only to the variables, global variables, headers, parameters, and tokens of SMM rules.
message body
and isup
parameters.others
can be used for the switchValue
which represents all the values which are not explicitly specified.