In this section:

 

Overview

Use the SIP Param Based Action profile object in conjunction with SIP Message Manipulation (SMM) processing to enable secondary trunk group selection.  

By default, the SBC selects the ingress trunk group for an incoming SIP request based on its source IP address and port. However, using SMM, you can extract a value from the incoming message and use the value to select a new ingress trunk group. This secondary trunk group selection enables applying trunk group policies and profiles on a more granular basis in subsequent processing of the session.

The SIP Param Based Action profile maps values that might be extracted from incoming messages, using the SMM storeSipParam operation, to specific SIP trunk group names. If the extracted storeSipParam value matches an entry configured in a SIP Param Based Action profile specified with the SMM storeProfileName operation, the SBC selects the trunk group specified by the matching entry as the new ingress trunk group.

When you define entries within a SIP Param Based Action profile you specify the type of matching to perform. The options include: 

  • full - entries using the full option include a list of one or more specific parameter values. The extracted value must match one of the entry's specified values exactly to be considered a match. For example, the list might consist of a set of host names.    
  •  range - entries using the range option define a starting value and an ending value in the entry. The extracted value must fall within the range to be considered a match. For example, the range might consist of numeric range for the username.
  • regexp - entries using the regexp option define the entry using a regular expression. The extracted value must match the regular expression to be considered a match.

If a match occurs, in all subsequent processing, the SBC considers the profiles and configurations called for by the new ingress trunk group. This includes CAC, SMM, Emergency profiles, and so on. If the extracted value does not match any of the entries in the profile, the SBC does not select a new ingress trunk group and continues using the original ingress trunk group.

Note

SMM rules can also be configured with the operation storeIpTg to select a new ingress trunk group. If you configure rules using both types of operations:

  • The ingress trunk group selected using the storeProfileName operation takes precedence over one selected using the storeIpTg operation.
  • If the storeProfileName operation does not find a new trunk group, the trunk group selected by the storeIpTg operation becomes the new ingress trunk group.
  • If neither the storeProfileName operation nor the storeIpTg operation selects a new trunk group, the SBC continues to use the original ingress trunk group as the ingress trunk group.

Command Syntax

Use following CLI syntax to configure a SIP Param Based Action profile.

%   set profiles signaling sipParamBasedActionProfile <profileName> 
          action <none | selectTG>
          entry <0 to 2056>
             trunkGroupName <trunk group name>
             matchType 
               full 
                 param <parameter value>
               none
               range 
                 rangeEnd <end of parameter range>
                 rangeStart <start of parameter range>
               regexp
                 paramRegexp <regular expression>

Command Parameters

SIP Param Based Action Profile Parameter

ParameterLength/RangeDescription

sipParamBasedActionProfile
<profileName>

up to 23 characters

Name for the sipParamBasedActionProfile.

action

n/a

Action to be performed by the sipParamBasedActionProfile. Options are:

  • none
  • selectTG

entry

0 to 2056Index value for the entry. A sipParamBasedActionProfile can contain a maximum of 2056 entries.

trunkGroupName

up to 23 charactersThe name of the trunk group to set as the new ingress trunk group if the corresponding entry matches the value extracted with the SMM storeSipParam operation.

matchType

n/a

Type of matching to use when comparing the value extracted with the SMM storeSipParam operation with the corresponding entry. Options are:

  • full - compare against the list of param values defined for the entry. The extracted value must match exactly.
  • none - (default) matching is not done.
  • range - compare against a defined range. The extracted value must be within the range to match.
  • regexp - compare against a defined regular expression. The extracted value must match the regular expression.

param

up to 128 charactersParameter value to compare against when matchType is full. More than one param value can be defined for an entry when matchType is full.

rangeEnd

up to 128 charactersEnding value for a range to compare against when matchType is range.

rangeStart

up to 128 charactersStarting value for a range to compare against when matchType is range.

paramRegexp

up to 128 charactersRegular expression to compare against when the matchType is regexp.

Command Example

The following commands create a sipParamBasedActionProfile named "PROFILE" that defines three entries to compare against the parameter extracted with the storeSipParam operation. The first entry uses full matching and specifies that if the extracted parameter is "username1," "username2," or "username3," then the new ingress trunk group is "TG1." The second entry uses regular expression matching and specifies that if the extracted parameter matches the regular expression "02*" then the new ingress trunk group is "TG2." The third entry uses range matching and if the extracted parameter is within the range 8000000000 and 9999999999, then the new ingress trunk group is "TG3."

% set profiles signaling sipParamBasedActionProfile PROFILE action selectTG
% set profiles signaling sipParamBasedActionProfile PROFILE 
% set profiles signaling sipParamBasedActionProfile PROFILE entry 1 trunkGroupName TG1 matchType full param username1
% set profiles signaling sipParamBasedActionProfile PROFILE entry 1 param username2
% set profiles signaling sipParamBasedActionProfile PROFILE entry 1 param username3
% set profiles signaling sipParamBasedActionProfile PROFILE entry 2 trunkGroupName TG2 matchType regexp paramRegexp 02*
% set profiles signaling sipParamBasedActionProfile PROFILE entry 3 trunkGroupName TG3 matchType range rangeStart 8000000000 rangeEnd 9999999999
% commit