Action
|
- add—Adds a new
header, if that header does not exist.
- delete—Deletes
the header, if it exists.
- find-replace-all—Finds all matching
headers and replaces with the header you specified for “Split” and "Join."
- log—Logs the
header.
- manipulate—Manipulates the elements of
this header to the element rules configured.
- monitor—Monitors
the header.
- store—Stores the
header.
- none—(default)
No action is taken.
- reject—Rejects
the header.
- sip-manip—Manipulates the SIP elements
of this header to the element rules configured.
Default: None.
|
Comparison type
|
- boolean—Header
is compared to header rule and must match exactly or it is rejected.
- case-insensitive—Header is compared to
header rule regardless of the case of the header.
- case-sensitive—(default) Header is
compared to the header rule and case must be exactly the same or it is
rejected.
- pattern-rule—Header is compared to the
header rule and the pattern must be exactly the same or it is rejected.
- refer-case-insensitive—Header is
compared to the header rule regardless of the case in a REFER message.
- refer-case-sensitive—Header is
compared to the header rule and the case must be exactly the same as in the
REFER message or it is rejected.
Default: Case-sensitive.
|
Format
|
- ascii-string - A
character-encoding scheme that represents text (128 ASCII codes, 7 bits).
- binary-ascii -
An encoding scheme where each byte of an ASCII character is used. Can use up to
256 bit patterns .
- hex-ascii - An
encoding scheme that uses a string of numbers (no spaces) to represent each
ASCII character.
|
Header name
|
The name of the header to which the rule
applies. Case-sensitive.
|
Match value
|
The value that you want to match against
the element value for an action to be performed.
|
Match val type
|
The type of value to match to the
match-field entry for the action to be performed.
- any—(default)
Element value in the SIP message is compared with the match-value field entry.
If the match-value field is empty, all values are considered a match.
- fqdn—Element
value in the SIP message must be a valid FQDN to be compared to the match-value
field entry. If the match-value field is empty, any valid FQDN is considered a
match. If the element value is not a valid FQDN, it is not considered a match.
- ip—Element value
in the SIP message must be a valid IP address to be compared to the match-value
field entry. If the match-value field is empty, any valid IP address is
considered a match. If the element value is not a valid IP address, it is not
considered a match.
|
Media type (SDP descriptor for SDP media
rule)
|
- m—Media name and
transport address
- i—Media title
- c—Connection
information (optional when configured at the session level)
- b—Zero or more
bandwidth information lines
- k—Encryption key
- a—Zero or more
media attribute lines
- t—The session
time is active
- r—Zero or more
repeat times
|
Methods
|
SIP method names to which you want to apply
the header rule. For example, INVITE, ACK, BYE. When this field is empty, the
system applies the MIME rule to all methods. Default: Blank.
|
Mime header
|
The parameter name to which the rule
applies. The parameter name depends on the element name you entered. For
uri-param, uri-user-param, and header-param it is the parameter name to be
added, replaced, or deleted. For all other types, it serves to identify the
element rule and any name can be used. Alpha-numeric characters. Default:
blank.
|
Msg type
|
- any—(default)
Requests, replies, and out-of-dialog messages
- out-of-dialog—Out of dialog messages
only.
- reply—Reply
messages only
- request—Request
messages only
Default: Any.
|
Name
|
The name you want to use for the rule.
Default: Blank.
|
New value
|
The value for a new element or replacement
value for an existing element. You can enter an expression that includes a
combination of absolute values, pre-defined parameters, and operators.
- Absolute
values—Use double quotes for clarity. You must escape all double quotes and
back slashes that are part of an absolute value, and enclose the absolute value
in double quotes.
- Pre-defined
values.—Pre-defined parameters always start with a $. For valid values, see the
Pre-defined Parameters table.
- Operators
parameters—For valid values, see the Operators table.
The following table describes the pre-defined parameters.
The following table describes the Operators.
|
Parameter name
|
The parameter name to which the rule
applies. The parameter name depends on the element name you entered. For
uri-param, uri-user-param, and header-param it is the parameter name to be
added, replaced, or deleted. For all other types, it serves to identify the
element rule and any name can be used. Alpha-numeric characters. Default:
Blank.
|
Type
|
The type of element on which to perform the
action. Default: Blank.
- header-param—Perform the action on the
parameter portion of the header.
- header-param-name—Perform the action
on the header parameter name.
- header-value—Perform the action on the
header value.
- mime—Perform the
action on Multipurpose Internet Mail Extensions (MIME).
- reason-phrase—Perform the action on
reason phrases.
- status-code—Perform the action on
status codes.
- teluri-param—Perform the action on a
SIP telephone Uniform Resource Identifier (URI).
- uri-display—Perform the action on the
display of the SIP URI.
- uri-header—Perform the action on a
header included in a request constructed from the URI.
- uri-header-name—Perform the action on
a SIP URI header name.
- uri-host—Perform
the action on a Host portion of the SIP URI.
- uri-param—Perform the action on the
parameter included in the SIP URI.
- uri-param-name—Perform the action on
the name parameter of the SIP URI.
- uri-phone-number-only—Perform the
action on a SIP URI phone number only.
- uri-port—Perform
the action on the port number portion of the SIP URI.
- uri-user—Perform
the action on the user portion of the SIP URI.
- uri-user-only—Perform the action on
the user portion only of the SIP URI.
- uri-user-param—Perform the action on
the user parameter of the SIP URI.
|
Type (SDP descriptor for SDP line rule)
|
- v—Protocol
version
- o—Originator and
session identifier
- s—Session name
- i—Session
information
- u—URI of
description
- e—Email address
- p—Phone number
- c—Connection
information (not required when included in all media)
- b—Zero or more
bandwidth information lines or one or more time descriptions("t=" and "r="
lines)
- z—Time zone
adjustments
- k—Encryption key
- a—Zero or more
session attribute lines or zero or more media descriptions
- t—Time the
session is active
- r—Zero or more
repeat times
|