Page History

Overview

SIP Adaptor Profile

Flexible Policy Adaptor Profile

The SIP Adaptor 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:

• SIP header value
• Presence or absence of a header
• String in a message body
• Parameter value
• Presence or absence of a parameter

The following CLI objects are used in supporting flexible policy and routing.

• The profileType parameter is used to specify whether a SIP Adaptor Profile is used for flexible policy or message manipulation (default).

• The flexiblePolicyAdapterProfile zone object is used to assign a flexible policy-specific SIP Adaptor Profile to a specific zone.

• The flexiblePolicyAdapterProfile SIP trunk group object is used to assign a flexible policy-specific SIP Adaptor Profile to a specific trunk group.

Command Syntax

Use following CLI syntax to configure SIP Adaptor Profiles.

SIP Adaptor Profile High Level

% set profiles signaling sipAdaptorProfile <profile_name> 
	advancedSMM <disabled | enabled>
	profileType <flexiblePolicy | messageManipulation> 
	rule <index> (see 'rule' syntax below)
	state <disabled | enabled>

SIP Adaptor Profile Parameters

sipAdaptorProfile

The name of the SIP Adaptor Profile. Up to 512 profiles are configurable.

Rule Parameters

% set profiles signaling sipAdaptorProfile <profile name> rule <index>
	action (see 'Rule Action Syntax' below)
	applyMatchHdrRange <eight | five | four | last | nine | seven | six | ten | three | two | undefined>
	applyMatchHeader <all | eight | five | four | last | nine | one | seven | six | ten | three | two>
	criterion

		switch
		type

Rule Parameters Table

The index number of the SMM rule within the SIP Adaptor Profile.

action


1-128

Rule Action Parameters

Rule Action Parameters

% set profiles signaling sipAdaptorProfile <profile name> rule <index> action <index>
	from type <globalVariable | header | isupParameter | messageBody | parameter | sdpContent | token | value | variable | variable>flexVariable>
	headerInfo <fieldValue	from flexVariableValue <flexvar1 | headerValueflexvar2 | undefined>
	headerPosition <first flexvar3 | lastflexvar4 | undefined>
	operation (see 'operation' syntax below)
	paramType <generic | undefined | uri | userinfo>
	regexp 
		matchInstance <all | five | four | last | one | flexvar5 | flexvar6 | flexvar7 | flexvar8 | flexvar9 | flexvar10 | flexvar11 | flexvar12 | flexvar13 | flexvar14 | flexvar15 | flexvar16>
	headerInfo <fieldValue | headerValue | undefined>
	headerPosition <first | last | undefined>
	operation (see 'operation' syntax below)
	paramType <generic | undefined | uri | userinfo>
	regexp 
		matchInstance <all | five | four | last | one | three | two>
		string <sting>
	to type <cdrField | header | isupParameter | messageBody | parameter | sdpContent | token | variable>
	type <header | isupParameter | message | messageBody | parameter | sdpContent | token | undefined | variable>

Action Parameters

variableValue – Details the variable type of this SIP PDU Manipulation entry.

Configuration Examples

set profiles signaling sipAdaptorProfile smm1 rule 1 action 1 from type flexVariable
set profiles signaling sipAdaptorProfile smm1 rule 1 action 1 from flexVariableValue flexVar1
commit

Rule Criterion Switch Parameters

% set profiles signaling sipAdaptorProfile <name> rule <index> criterion <index> switch <index>
	switchAction <1-128>
	switchValue <value>
	switchRegexpString <regular expression>

Rule Criterion Switch Parameters

Rule Criterion Type Parameters

% set profiles signaling sipAdaptorProfile <profile name> rule <index> criterion <index> type
	globalVar
		condition
		globalVariableID
		regexp 
		value 
	header 
		condition
		hdrInstance 
		hdrRange 
		name 
		numberOfInstances 
		regexp 
		value
	isupParameter
		condition
		paramCode
		paramEmbeddedCode
		paramSubType 
		paramValue
	message
		condition 
		messageTypes 
		methodTypes
        operation
		statusCode 
		statusRange
	messageBody 
		condition 
		messageBodyType 
		regexp
	parameter  
	sdpContent
		codecNames 
		condition 
		streamInstanceId 
		streamType
	token
		condition 
		regexp 
		tokenType 
		value
	variable
		condition 
		otherVariableID 
		regexp
		value 
		variableID 

Rule Criterion Type Parameters

Rule Criterion Type Parameters

Parameter	Description
globalVar	Specifies for which value of the global variable the rule is applicable. The criteria must be present in global variable rules. condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined") absent exist has-value not-equal-to regex-match undefined (default) variables-equal variables-not-equal globalVariableID – Details the global variable type of this SIP PDU Manipulation entry. (default is "undefined"):    egressTgName – Do not use this in a SMM profile defined at the Zone level. This parameter can only be used in an outputAdaptor profile. ingressTgName – Do not use this in a SMM profile defined at the Zone level. This parameter can only be used in an outputAdaptor profile.   localIP localPort sigportid srcipaddr srcport undefined (default) regexp – Options are: numMatch – Apply the criterion associated with a number match for a regular expression. match noMatch string – The regular expression text of this criterion entry. value – The criterion's value of this SIP PDU Manipulation criterion entry.
header	Specifies the header for which the rule is applicable. condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined")   absent exist has-value not-equal-to regex-match undefined hdrInstance – Apply criteria on header instance number (default is "all). all eight five four last nine one seven six ten three two hdrRange – This is an optional upper range of header instances. (default is "undefined") eight five four last nine seven six ten three two undefined name – The header name or parameter name of this SIP PDU Manipulation criterion entry.  numberOfInstances – This value specifies a number of header instances for validation. Used when a header criterion is the number of headers of a particular type: number – Criterion required to have total number of header instance. qualifier – The total number of headers matching this condition. (default is "undefined") equal greater lessthan undefine regexp – Specifies the regular expression string against which comparison would be performed to find the matches. numMatch – Apply the criterion associated with a number match for a regular expression. (default is "match")   match noMatch string – Regular expression text of this criterion entry. value – The criterion's value of this SIP PDU Manipulation criterion entry.
isupParameter	Use this object to define ISUP parameter matching conditions. condition – The pattern matching condition of this ISUP Manipulation criterion entry.   absent exist has-value not-equal-to regex-match undefined variables-equal variables-not-equal paramCode <hex value in range of (00..ff)>[00]> – The criterion's parameter code of this ISUP Manipulation criterion entry. paramEmbeddedCode <hex value in range of (00..ff)>[00]> – The criterion's parameter embedded code of this ISUP Manipulation criterion entry. paramSubType <hex value in range of (00..ff)>[ff]> – The criterion's parameter sub-code of this ISUP Manipulation criterion entry. paramValue <number> – The criterion's parameter value of this ISUP Manipulation criterion entry.
message	Specifies whether the rule should apply for requests/responses/both, method name and if applicable response code/response code range. Options are: condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined")   absent exist has-value not-equal-to regex-match undefined  variables-equal variables-not-equal    messageTypes – The SIP PDU manipulation message types of this rule entry. (default is "undefined") all request requestAll response responseAll undefined methodTypes – The SIP PDU manipulation method types of this rule entry. (default is ""). The SBC accepts more than one method type. The SBC accepts a single methodType or [list of methodTypes], such as ack or [ ack ] or [ ack bye cancel]. ack bye cancel info invite message notify options prack publish refer register subscribe undefined update operation teardown – This parameter is used to tear down a call gracefully by the value configured in the response code (applies to request messages only). reject responseCode values: (100-699) statusCode – The status code of SIP PDU manipulation rule. (range: 100-699 / default = 0). The SBC provides options for the statusCode variable in sipAdaptorProfile, The additional options for statusCode are as follows: single statusCode or list of status codes such as 480 or [ 480 ] or [ 480 486 484 ] All (all status codes from 400 to 699) All4xx All5xx All6xx statusRange – The status code range of SIP PDU manipulation rule. (range: 100-699, and greater than value of statusCode / default = 0).
messageBody	Specifies the message body for which the rule is applicable. This criteria must be present in the message body rules. Options are: condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined") absent exist has-value not-equal-to regex-match undefined variables-equal variables-not-equal messageBodyType – Details the message body type of this SIP PDU Manipulation entry. Options are:   all isup sdp undefined regexp – Specifies the regular expression string against which comparison would be performed to find the matches. Options are: numMatch – Apply the criterion associated with a number match for a regular expression. (default is "match") match notmatch string – Regular expression text of this criterion entry.
parameter	The parameter for which the rule is applicable. This criteria element must be present in Parameter rules. condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined")   absent exist has-value not-equal-to regex-match undefined name – The header name or parameter name of this SIP PDU Manipulation criterion entry. paramType – Details the Parameter type of this SIP PDU Manipulation entry. (default is "undefined")   generic undefined uri userinfo regexp – Specifies the regular expression string against which comparison would be performed to find the matches. numMatch – Apply the criterion associated with a number of match for a regular expression. (default is "match")  match notmatch string – Regular expression text of this criterion entry. value – The criterion's value of this SIP PDU Manipulation criterion entry.
sdpContent	SDP Content configuration objects. (See SDP Content Parameters table).
token	Specifies the token type to act upon by the action. condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined")   absent exist has-value not-equal-to regex-match undefined regexp – Specifies the regular expression string against which comparison would be performed to find the matches. Options are: numMatch – Apply the criterion associated with a number match for a regular expression. Options are: match notmatch string – The regular expression text of this criterion entry. tokenType – Details the token type of this SIP PDU Manipulation entry. (default is "undefined")   undefined uridisplayname urihostname urihostport urischeme uriusername value – The criterion's value of this SIP PDU Manipulation criterion entry.
variable	The ID of the internal variable to apply with this Action. condition – The pattern matching condition of this SIP PDU Manipulation criterion entry. (default is "undefined")   absent exist has-value not-equal-to regex-match undefined regexp – Specifies the regular expression string against which comparison would be performed to find the matches. numMatch – Apply the criterion associated with a number match for a regular expression. (default is "match") match notmatch string – The regular expression text of this criterion value – The criterion's value of this SIP PDU Manipulation criterion entry.  variableID – Details the variable type of this SIP PDU Manipulation entry. undefined var1-var100

SDP Content Parameters

% set profiles signaling sipAdaptorProfile <profile name> rule <index> criterion <index> type sdpContent
	codecNames <string, max: 256 chars>[]
	condition 
	streamInstanceId 
	streamType  

SDP Content Parameters

SDP Content Parameters

Parameter	Description
codecNames	Specifies codec name or a list of comma separated codec names. At most 25 comma separated codec names are supported. When specifies the codecNames for filterCodec operation, a * is used as a wildcard and only one wildcard is allowed. This wild card can appear in any position. (range: 1-128 characters).
condition	The pattern-matching condition of this SDP Manipulation criterion entry. absent xist has-value not-equal-to regex-match undefined variables-equal variables-not-equal
streamInstanceId	<all, last, or a value in range: 1-99> – Specifies the stream instance ID for the specified media stream. For example: if the streamInstanceId value is "last", the action applies to the last instances for a particular stream type.
streamType	<application | audio | data | image | message | session | text | video> – Specifies the type media stream to use for this SIP Adaptor Profile. For example: If the media stream is "session", message should operate at the session level.
sdpContentSubType	Use this primitive to further define additional SDP content type information during an action operation. codecByName: Take action against codec specified in sdpContent configuration. codecByPosition: Use the position of the codes as appears in the m=line as specified in sdpContent configuration. line: Use SDP line as specified in sdpContent configuration. parameter: Use parameter in a given SDP line as specified in sdpContent configuration. stream: Use SDP stream as specified in sdpContent configuration.

Operation Parameters

Table1Operation Parameters3Operation Parameters

Parameter	Description
add	Add a header, parameter, token or messageBody using configured value.
addDigits	Use this operation to either add or replace the digits within these parameters. NOTE: This operation only applies to parameters calling party number, called party number, called IN number, location number, redirection number, original called number, redirecting number, connected number of generic number.
append	Append a configured value to a variable.
asciiToBinaryAppend	Converts an ASCII string of hexadecimal digits into an array of hexadecimal binary bytes e.g. “1234” is converted to 0x12, 0x34 and appends to the SMM variable.
asciiToBinaryStore	Converts an ASCII string of hexadecimal digits into an array of hexadecimal binary bytes e.g. “1234” is converted to 0x12, 0x34 and stores it to the SMM variable.
binaryToAsciiAppend	Converts hexadecimal binary data into the equivalent ASCII string, e.g. the number 0x12, 0x34 into the string “1234” (0x31, 0x32, 0x33, 0x34) and appends it to the SMM variable.
binaryToAsciiStore	Converts hexadecimal binary data into the equivalent ASCII string. e.g. the number 0x12, 0x34 into the string “1234” (0x31, 0x32, 0x33, 0x34) and stores it to the SMM variable.
bitAND	Bitwise AND operation for SMM variable (hex value)
bitNOT	Bitwise NOT operation for SMM variable (hex value)
bitOR	Bitwise OR operation for SMM variable (hex value)
bitXOR	Bitwise XOR operation for SMM variable (hex value)
createuri message uriInfo	Create a SIP URI using following sub-parameters. The SIP URI is stored in the specified variable. The "to" type for this operation is a variable. uriDisplayName – URI display name (string or variable) [optional]. uriHostName – URI host name (string, variable or global variable). uriHostPort – URI host port (string, variable or global variable) [optional]. uriScheme – URI scheme (string or variable). uriUserName – URI user name (string or variable). NOTE: Use "createuri" operation for any header except Request-Line, From and To headers. NOTE: SBC supports SIP URI messages containing up to 20 parameters in any SIP header. However, increasing the number of URI parameters impacts memory usage. For example, increasing the number of parameters from 10 to 20 will increase memory usage by approximately 10 percent.
delete	Delete a header, parameter or a token.
filterCodec	Filter/rearrange the codec in the media line according the specified patterns. The patterns contain up to 25 comma-separated codec names or the wildcard codec "*".  There should be no more than one wildcard "*" codec appearing in the codec pattern.
getCodecPosition	Obtain the corresponding position/order of a given codec as it appears in the media line. The position/order of the codec is stored in the variable as specified in the To operand. If the corresponding payload type of the specified codec is not found, “0” is stored in the variable as specified in the To operand.
getDigits	Use this operation to use the value in the parameters to populate the SMM variable. This operation only applies to parameters calling party number, called party number, called IN number, location number, redirection number, original called number, redirecting number, connected number of generic number.
getPayloadType	Obtain the corresponding payload type of a given codec if the payload type exists in the media line. The value of payload type is stored in the variable as specified in the To operand. If the corresponding payload type of the specified codec does not exist in the  media line, this action is ignored.
ignore	Drop a message silently on the inbound leg, and do not send on the outbound leg.
modify	Modify header value, parameter, and token using configured value or regular expression-based text manipulation, or else modify messageBody content using regular expression based text manipulation only.
nextRouteActionOnCrankBack	Invoke crankback functionality by assigning this operation to a predefined action value and using the options below to specify the next route action to take. the SMM rule is added so that "nextRouteActionOnCrankBack" is set to a predefined action value. actionType none (default) – No crankback is performed and the SBC falls back to its original behavior. AttemptLastRoute - The SBC performs crankback and attempts the last available route.  AttemptNextRoute – The SBC performs crankback and attempts the next available route. DisconnectAfter3xxRoutes - The SBC stops crankback (disconnect call) when all contacts in a received 3xx responses are exhausted. DisconnectCall -- If set, the call is immediately disconnected after attempting all 3xx routes. SkipRemainingRoutes – The SBC skips the remaining routes available and performs the crankback for the next available contact. If the contact is not available, the SBC attempts the remaining routes in the initial route set. generateAttemptRec  true – The attempt record will be generated for each crankback attempt. false (default) – The SBC resorts to legacy behavior.
regappend	Insert configured value after the matching sub-string.
regdel	Delete the matching sub-string.
regpostdel	Delete the part after the matching sub-string.
regpostsub	Replace the part after the matching sub-string using configured value.
regpredel	Delete the part before the matching sub-string.
regprepend	Insert configured value before the matching sub-string.
regpresub	Replace the part before the matching sub-string using configured value.
regstore	Store the matching sub-string to a variable or the regular expression sub-expression matches into a range of variables.
regsub	Replace the matching sub-string using configured value.
reject message	Reject a message by the value configured in the response code (applies to request messages only). reject responseCode values: (100-699)
rename	Rename a header.
store	Store a parameter, a variable or header value into a variable.
storeIpTg	Use this operation command to allow the SBC to store a new IP trunk group based on the SIP Message Manipulation (SMM) configuration.
storeProfileName	Stores the name of a sipParamBasedActionProfile to use in selecting a new ingress trunk group.
storeSipParam	Extracts a specified value (header, parameter, token) from the incoming SIP message to compare to mapping defined in a sipParamBasedActionProfile in order to select a new ingress trunk group.
undefined	Default value.
writeCdr	Write CDR to a field specified in 'to type cdrField' action.

Type Parameters

Type Parameters

Command Examples

View SIP Adaptor Profile

% show profiles signaling sipAdaptorProfile
	sipAdaptorProfile Test { 
		state enabled; 
		rule 1 { 
			criterion 1 { 
				type parameter; 
				parameter { 
					condition exist; 
					paramType generic; 
					name 1; 
					value 1; 
				} 
			} 
			action 1 { 
				regexp { 
					string 1; 
					matchInstance all; 
				} 
			} 
		} 
	} 

Perform SIP header manipulation

Use the following commands to perform the message manipulation on Egress INVITE Request-URI user name part. After the manipulation, +1 is prefixed to user name part of Request-URI in Egress INVITE.

% set profiles signaling sipAdaptorProfile SMM_01 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 criterion 1 type message message condition exist messageTypes request methodTypes invite 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 criterion 2 type header header condition exist name request-line 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 criterion 2 type header header numberOfInstances number 1 qualifier equal
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 criterion 3 type token token condition exist tokenType uriusername   
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 action 1 type token 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 action 1 operation regprepend  
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 action 1 regexp string [^/d] 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 action 1 to token uriusername 
% set profiles signaling sipAdaptorProfile SMM_01 rule 1 action 1 from value +1   
% set profiles signaling sipAdaptorProfile SMM_01 state enable   

To view the configured profile:

% show profiles signaling sipAdaptorProfile SMM_01 

After the Profile is created, configure it on Egress trunk group under outputAdapterprofile:

 set addressContext a1 zone EXTERNAL sipTrunkGroup BLR_EXT signaling messageManipulation outputAdapterProfile SMM_01

Configure SMM rule using SMM switch criteria

set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 1 type message message messageTypes request
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 1 type message message methodType subscribe
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 2 type header header condition exist
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 2 type header header name "p-charging-vector"
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 2 type header header numberOfInstances number 1 qualifier equal
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter paramType generic
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter name "icid-generated-at"
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter condition multi-has-value
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter switch 1 switchValue "someproxy.sipart.com" switchAction 7
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter switch 2 switchValue abc.sipart.com switchAction 9
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter switch 2 switchRegexpString abc.*.com switchAction 9
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 criterion 3 type parameter parameter switch 3 switchValue others switchAction 1
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 1 type message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 1 operation reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 1 message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 1 message reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 1 message reject responseCode 500
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 7 type message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 7 operation reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 7 message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 7 message reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 7 message reject responseCode 503
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 9 type message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 9 operation reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 9 message
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 9 message reject
set profiles signaling sipAdaptorProfile SMM_PROFILE_S150_OUT rule 1 action 9 message reject responseCode 400

Teardown Message

% set profiles signaling sipAdaptorProfile Test6 rule 1 action 1 type message operation teardown message teardown responseCode 488