SIP Adaptor Profile - CLI

sipAdaptorProfile

1-23

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

Enable flag to apply advanced SMM logic, such as dialog stateful variables, to INVITE, REGISTER, SUBSCRIBE messaging. For an example SMM rule, see How to Treat Hostpart Based on the Received Format.

• disabled  (default)
• enabled

NOTE: Dialog Stateful variables are not applied for the NOTIFY messages received prior to receiving 200 OK response to the Egress SUBSCRIBE.

When creating a SIP Adaptor Profile, use this parameter to specify whether a SIP Adaptor Profile is to be used for flexible policy or message manipulation.

• messageManipulation (default) – The SBC performs message manipulation based on this SIP Adaptor Profile.
• flexiblePolicy – The SBC performs dynamic policy and routing based on SIP message information elements as specified in this SIP Adaptor Profile.

rule

1-768

Use this object to define the SIP Message Manipulation (SMM) rule within the SIP Adaptor Profile. Specify the SSM rule index number, and then configure the parameters as listed in the Rule Parameters section below.

state

N/A

The administrative state of this SIP PDU Manipulation entry.

• disabled (default)
• enabled

rule

1-768

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

action


1-128

<actionId#> – Specify the action index, and then configure associated parameters as shown below. (See Action Parameters table below for details)

applyMatchHdrRange

N/A

The range of the filtered header instances which are to be modified. The following is the valid set of values for this field:

• two
• three
• four
• five
• six
• seven
• eight
• nine
• ten
• last
• undefined (default)

applyMatchHeader

N/A

This value specifies the matching header. The following are the valid set of values for this field:

• all
• one (default)
• two
• three
• four
• five
• six
• seven
• eight
• nine
• ten
• last

criterion

1-20

Identifies the SIP PDU manipulation Criterion.

• switch
• type

(See Rule Criterion Switch Parameters and Rule Criterion Type Parameters tables below for parameter details)

Use to configure source message parameters.

• globalVariable globalVariableValue – Choose the global variable to take action against (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
• header value <string> – Enter the header value.
• isupParameter
  

  • paramCode – Enter Hex value in range of (00..ff)>[00].

  • paramEmbeddedCode – Enter hex value in range of (00..ff)>[00].

  • paramSubType – Enter hex value in range of (00..ff)>[ff].

• messageBody messageBodyValue – Select message body type (default is "all"): all | isup | sdp | undefined
  
• parameter value <string> – Enter the parameter value.
• token tokenValue – Choose a token type (default is "undefined"). undefined | uridisplayname | urihostname | urihostport | urischeme | uriusernamevalue
• value <string>  
• variable


  • length <all, or a value in range 1-255> – The number of bytes from selected byte for manipulation. Default = all (use all remaining bytes).

  • offset <whole, or a value in range 0-254> – The position of first byte for manipulation. Default is whole (use all bytes).

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

    • undefined
    • var1, var2, var3...var100

The operation type of this SIP PDU manipulation action entry. (See Operation Parameters table below for details)

 Parameter type:

• generic
• undefined (default)
• uri
• userinfo

Specifies the regular expression string against which comparison is performed to find the matches.

• matchInstance – Apply the action associated with a regular expression to a particular match instance.string (the regular expression text of this action entry).
  
  • one (default)
  • two
  • three
  • four
  • five
  • last
  • all
• string – The regular expression text of this action entry.

Use this object to configure destination message parameters. (See Type Parameters table below for details)

cdrField | header | isupParameter | messageBody | parameter | sdpContent | token | variable

Use this field to specify object type to take action against. (See Type Parameters table below for details).

header | isupParameter | message | messageBody | parameter | sdpContent | token | undefined | variable

Use this object to define the SMM switch criterion.

NOTE: Ensure actions configured under this parameter are also present in the list of created actions.

<switch criterion value> – The switch criterion's value for this SIP PDU Manipulation criterion entry.

NOTE: Use the keyword others is used for switchValue which represents all the values which are not explicitly specified.

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.

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.
  

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.

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).

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.

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.

SDP Content configuration objects. (See SDP Content Parameters table).

 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

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

<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.

<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.

Use this primitive to further define additional SDP content type information during an operation action.

• 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.

Add a header, parameter, token or messageBody using configured value.

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 a configured value to a variable.

asciiToBinaryStore

binaryToAsciiStore 

bitAND

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.

Drop a message silently on the inbound leg, and do not send on the outbound leg.

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.

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.

Insert configured value after the matching sub-string.

Delete the matching sub-string.

Delete the part after the matching sub-string.

Replace the part after the matching sub-string using configured value.

Delete the part before the matching sub-string.

Insert configured value before the matching sub-string.

Replace the part before the matching sub-string using configured value.

Store the matching sub-string to a variable or the regular expression sub-expression matches into a range of variables.

Replace the matching sub-string using configured value.

Reject a message by the value configured in the response code (applies to request messages only).

reject responseCode values: (100-699)

Rename a header.

Store a parameter, a variable or header value into a variable.

Use this operation command to allow the SBC to store a new IP trunk group based on the SIP Message Manipulation (SMM) configuration.

Default value.

Write CDR to a field specified in 'to type cdrField' action.

<cdr1 | cdr2 | cdr3 | cdr4 | cdr5> – Use this enum to select a specific CDR field to store a CDR string. Use in conjunction with writerCdr operation.

value <string> – Enter the header value.

isupParameter

value <string> – Enter parameter value.

tokenValue – Select token type to act upon. <undefined | uridisplayname | urihostname | urihostport | urischeme | uriusername>

Use this object to specify variable range, variable scope and variable values:

• variableRangeValue <var1..var100 | undefined>
• variableScopeValue <local | message>
• variableValue <var1..var100 | undefined>