SIP Header Manipulation
The following table lists SOAP attributes and sub-elements for SIP header manipulation.
| SOAP Attributes/Subelements | ACLI session-router->sip-manipulation | Default Values | Valid Values | SBC Version |
|---|---|---|---|---|
| acliObjectName * #
HeaderRule acliObjectName * # action matchValue msgType methods ElementRule acliObjectName *# aclitype action matchValueType matchValue newValue |
name
header-rule name action match-value msg-type methods element-rule name type action match-val-type match-value new-value |
none
any none any |
add, delete, manipulate, none
empty or <value> any, request, reply empty or comma separated strings header-value, header-param, uri-user, uri-host, uri-port, uri-param, uri-header, uri-user-param add, replace, delete-header, delete-element, none IP, FQDN, ANY empty or <255 characters> empty or combination of $ORIGINAL, $LOCAL_IP, $REMOTE_IP, $REMOTE_VIA_HOST, $TRUNK_GROUP, $TRUNK_GROUP_CONTEXT, <any string>, +, -, +^, -^ |
4.0.0 and above |
| acliObjectName * #
description HeaderRule acliObjectName * # headerName # action cmpType matchValue msgType newValue methods ElementRule acliObjectName *# paramName aclitype action matchValueType cmpType matchValue newValue |
name
description header-rule name header-name action comparison-type match-value msg-type new-value methods element-rule name parameter-name type action match-val-type comparison-type match-value new-value |
none
case-sensititive any none ANY case-sensitive |
255 characters
255 characters or @ status-line add, delete, manipulate, store, none case-sensitive, case-insensitive, pattern-rule empty or <reg-expr> any, request, reply empty or <reg-expr> empty or comma-seperated strings 255 characters 255 characters header-value, header-param-name, header-param, uri-display, uri-user, uri-user-param, uri-host, uri-port, uri-param-name, uri-param, uri-header-name, uri-header, status-code, reason-phrase, add, replace, delete-header, delete-element, store, none IP, FQDN, ANY case-sensitive, case-insensitive, pattern-rule empty or <reg-expr-value> empty or <reg-expr-value> with pre0defined parameters: $ORIGINAL, $LOCAL_IP, $REMOTE_IP, $REMOTE_VIA_HOST, $TRUNK_GROUP, $TRUNK_GROUP_CONTEXT |
4.1.1 and above |
| Header Rule
action cmpType newValue ElementRule cmpType newValue action aclitype |
header-rule
action comparison-type new-value element-rule comparison-type new-value action type |
none | add, delete, manipulate, store, none,
sip-manip
case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive empty, <reg-expr>, or <sip-manipulation> case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive empty or <reg-expr> with pre-defined parameters: $ORIGINAL, $LOCAL_IP, $LOCAL_PORT, $REMOTE_IP, $REMOTE_PORT, $REMOTE_VIA_HOST, $TRUNK_GROUP, $TRUNK_GROUP_CONTEXT add, replace, delete-header, delete-element, store, none, find-replace-all header-value, header-param-name, header-param, uri-display, uri-user, uri-user-param, uri-host, uri-port, uri-param-name, uri-param, uri-header-name, uri-header, statust-code, reason-phrase, mime |
4.1.4; 5.1.1 and above |
| HeaderRule
matchValue ElementRule aclitype matchValue |
header-rule
match-value element-rule type match-value |
empty or <regular-expr> with
$MANIP_STRING
header-value, header-param-name, header-param, uri-display, uri-user, uri-user-param, uri-host, uri-port, uri-param-name, uri-param, uri-header-name, uri-header, status-code, reason-phrase, mime, uri-user-only, uri-phone-number-only empty or <regular-expr> with $MANIP_STRING |
6.1.0 and above | |
| HeaderRule
acliObjectName * # action msgType matchValue newValue ElementRule action matchValue newValue |
header-rule
name action msg-type match-value new-value element-rule action match-value new-value |
none
any none |
unique and ordered with mime-rule,
mime-isup-rule
add, delete, manipulate, store, none, sip-manip, find-replace-all, reject, log any, request, reply, out-of-dialog empty or <regular-expr> with $MANIP_STRING, $MANIP_PATTERN empty or <regular-expr> or <sip-manipulation> or ACME_NAT_TO_FROM_IP add, replace, delete-header, delete-element, store, none, find-replace-all, reject, log, sip-manip empty or <regular-expr> with $MANIP_STRING ($M_STRING), $MANIP_PATTERN empty or <sip-manipulation> or <reg-expr> with reserved words and operators: $ORIGINAL, $LOCAL_IP/PORT, $REMOTE_IP/PORT, $REMOTE_VIA_HOST, $TRUNK_GROUP ($T_GROUP), $TRUNK_GROUP_CONTEXT ($T_CONTEXT), $REPLY_IP/PORT, $TARGET_IP/PORT, $TO/FROM/CONTACT/RURI/PAI/PPI/PCPID_USER/PHONE/HOST/PORT, $TIMESTAMP_UTC, $CALL_ID, &, |, ==, ~=, !=, <=, >=, <, > |
6.2.0 and above |
| MimeRules
acliObjectName * # contentType action cmpType msgType format methods matchValue newValue MimeHeaderRule acliObjectName *# mimeHeaderName# action cmpType matchValue newValue |
mime-rule
name content-type action comparison-type msg-type format methods match-value new-value mime-header-rule name mime-header-name action comparison-type match-value new-value |
none
case-sensitive any ascii-string none case-sensitive |
unique and ordered with header-rule,
mime-isup-rule
255 chars such as application/SDP, @preamble, @epilogue add, delete, manipulate, store, none, sip-manip, find-replace-all, reject, log case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive any, request, reply, out-of-dialog ascii-string, hex-ascii, binary-ascii empty or comma seperated strings 255 chars 255 chars such as Content-Disposition add, replace, store, none, sip-manip, find-replace-all, reject, log case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive |
6.2.0 and above |
| MimeISUPRules
acliObjectName * # contentType isupSpec isupMsgTypes action cmpType msgType methods matchValue newValue MimeHeaderRule MimeISUPParamRule acliObjectName *# parameterType parameterFormat action cmpType matchValue newValue |
mime-isup-rule
name content-type isup-spec isup-msg-types action comparison-type msg-type methods match-value new-value mime-header-rule isup-param-rule name type format action comparison-type match-value new-value |
ansi-2000
none case-sensitive any 0 hex-ascii none case-sensitive |
unique and ordered with header-rule,
mime-isup-rule
255 chars such as application/ISUP ansi-2000, itu-99, gr-317, etsi-356 empty or comma seperated list of 1-255 add, delete, manipulate, store, none, sip-manip, find-replace-all, reject, log case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive any, request, reply, out-of-dialog empty or comma seperated strings 255 chars 0-255 number-param, hex-ascii, binary-ascii, ascii-string, bcd add, replace, store, none, sip-manip, find-replace-all, reject, log case-sensitive, case-insensitive, pattern-rule, boolean, refer-case-sensitive, refer-case-insensitive |
6.2.0 and above |
| splitHdrList
joinHdrList |
split-headers
join-headers |
comma seperated list of header names such as "Allowed,P-Asserted-Identity", "Diversion,Allow" | 6.2.0M1 |