- Using Cisco Unified SIP Proxy Software
- Cisco Unified SIP Proxy Module EXEC Commands
- Cisco Unified SIP Proxy EXEC Commands
- Cisco Unified SIP Proxy Configuration Commands
- Cisco Unified SIP Proxy SIP Commands
- Cisco Unified SIP Proxy SIP Server Commands
- Cisco Unified SIP Proxy Radius Server Commands
- Cisco Unified SIP Proxy Trigger Commands
- Cisco Unified SIP Proxy Route Commands
- Cisco Unified SIP Proxy Policy Commands
- Cisco Unified SIP Proxy Accounting Commands
- Cisco Unified SIP Proxy Security Commands
- Module Commands for Cisco Unified SIP Proxy
CLI Command Reference for Cisco Unified SIP Proxy Release 10.1
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- November 11, 2019
Chapter: Cisco Unified SIP Proxy Trigger Commands
- trigger condition
- trigger post-normalization
- trigger pre-normalization
- trigger routing
- sequence (trigger)
- header (trigger sequence)
- in-network
- local-ip
- local-port
- message
- method (trigger sequence)
- mid-dialog
- out-network
- protocol
- proxy-route header-param
- proxy-route uri-component
- proxy-route uri-param
- remote-ip
- remote-port
- request-uri uri-component
- request-uri uri-param
- response-code
- time
- user-agent-hdr
Cisco Unified SIP Proxy Trigger Commands
Last Updated: November 25, 2019
- trigger condition
- trigger post-normalization
- trigger pre-normalization
- trigger routing
- sequence (trigger)
–
local-ip
– message
– protocol
– time
trigger condition
To create a trigger condition and enter Cisco Unified SIP Proxy trigger configuration mode, use the trigger condition command in Cisco Unified SIP Proxy configuration mode. To remove the trigger condition, use the no form of this command.
trigger condition trigger-condition-name
no trigger condition trigger-condition-name
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
This command configures a trigger condition. The trigger condition associates the trigger with the specific conditions that includes matching rules against certain headers or fields within a SIP message.
A trigger is a named condition that is evaluated as either true or false for each received request. If the condition is true, then preset behaviors are invoked.
To execute a module, the server:
1. Identifies appropriate triggers.
2. Orders the triggers by their sequence numbers.
3. Evaluates the named trigger condition for the request. If true, the next step is executed; otherwise, the next trigger is checked.
4. Determines the details of module execution from the parameters of the module trigger that corresponds to the matched trigger condition.
The trigger condition command provides a name for a trigger point, specifies a true-false test for the condition, and indicates its place in the set of triggers to evaluate. The types of conditions that can be evaluated as trigger points are:
- Whether a message is a request or response
- The type of request method
- The response code (either an explicit code or a class of codes)
- User agent header field value
- Matching portions of a Request-URI
- Matching portions of a Route header field
- Matching IP addresses and ports
Configure these trigger points using the commands in trigger configuration mode.
The trigger condition command takes as input regular expressions for conditions that must be matched in order for the trigger to be fired. For more information on regular expressions, see http://java.sun.com/docs/books/tutorial/extra/regex/.
Note All trigger conditions support regular expressions except the MESSAGE field, which can either be “response” or “request” only.
Examples
The following example creates a new trigger condition t1 and enters trigger configuration mode, where the specific condition is configured:
The following example deletes trigger condition t1:
Related Commands
trigger post-normalization
To configure a postnormalization algorithm for outgoing SIP messages to a specific normalization policy, use the trigger post-normalization command in Cisco Unified SIP Proxy configuration mode. To remove the postnormalization policy algorithm from the normalization policy, use the no form of this command.
trigger post-normalization sequence sequence-number { by-pass | policy policy } [ condition trigger-condition ]
no trigger post-normalization sequence sequence-number policy policy [ condition trigger-condition ]
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to determine which normalization policies are invoked after routing policies are applied. Use the trigger pre-normalization command to determine which normalization policies are invoked before routing policies are applied.
Examples
The following example calls for policy p1 to be invoked unconditionally:
The following example calls for the by-pass policy to be invoked unconditionally:
The following example deletes the call to policy p1 for post-normalization:
Related Commands
|
|
|
|---|---|
Configures a prenormalization algorithm for incoming SIP messages to a normalization policy. |
trigger pre-normalization
To configure a prenormalization algorithm for incoming SIP messages to a normalization policy, use the trigger pre-normalization command in Cisco Unified SIP Proxy configuration mode. To remove the prenormalization policy algorithm from the normalization policy, use the no form of this command.
trigger pre-normalization sequence sequence-number { by-pass | policy policy } [ condition trigger-condition ]
no trigger pre-normalization sequence sequence-number { by-pass | policy policy } [ condition trigger-condition ]
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
Use this command to determine which normalization policies are invoked before routing policies are applied. Use the trigger post-normalization command to determine which normalization policies are invoked after routing policies are applied.
Examples
The following example calls for policy p1 to be invoked unconditionally:
The following example calls for the by-pass policy to be invoked unconditionally:
The following example deletes the call to policy p1 for prenormalization:
Related Commands
|
|
|
|---|---|
Configures a postnormalization algorithm for outgoing SIP messages to a specific normalization policy. |
trigger routing
To associate a routing policy with a trigger condition, use the trigger routing command in Cisco Unified SIP Proxy configuration mode. To delete the association between the routing policy and the condition, use the no form of this command.
trigger routing sequence sequence-number { by-pass | policy policy } [ condition trigger-condition ]
no trigger routing sequence sequence-number { by-pass | policy policy } [ condition trigger-condition ]
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy configuration (cusp-config)
Command History
|
|
|
|---|---|
Usage Guidelines
Routing triggers determine which of the configured routing policies is invoked for a received request. When a characteristic of the request matches the specified condition, the specified routing policy is invoked to determine the request’s next hop.
Examples
The following example associates policy p1 with condition t1:
The following example associates the by-pass policy for condition mid-dialog :
The following example deletes the association of the policy with the condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
sequence (trigger)
To configure a sequence number for an existing trigger condition and enter trigger sequence configuration mode, use the sequence command in trigger configuration mode. To remove the sequence number from the trigger condition, use the no form of this command.
Syntax Description
Integer that indicates the order in which triggers are evaluated. |
Command Default
Command Modes
Trigger configuration (cusp-config-trigger)
Command History
|
|
|
|---|---|
Usage Guidelines
All trigger sequence configuration mode commands configure and conditions, that is, all conditions must be matched for a given trigger to fire. A list of trigger sequences is evaluated as a list of or conditions, so once one is matched those with later sequence numbers are ignored.
Examples
The following example assigns sequence number 1 to existing trigger condition t1:
The following example removes sequence number 1 from existing trigger condition t1:
Related CommandsTBD
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
header (trigger sequence)
To configure the trigger to fire when matching the regular expression for this header, use the header command in trigger sequence configuration mode. To, use the no form of this command.
header header-name { first | last | all } header-value
no header header-name { first | last | all } header-value
Syntax Description
Specifies to trigger on the first occurrence of this header. |
|
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures this trigger to fire on the first occurrence of the header user@example.com:
The following example removes the trigger condition using mid-dialog:
in-network
To configure the incoming network for a trigger condition for a server-side transaction, use the in-network command in trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
Syntax Description
Specifies the incoming network name for the trigger condition. |
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the in-network field for the network called “internal” for the trigger condition:
The following example removes the in-network field from the trigger condition:
Related Commands
|
|
|
|---|---|
Configures the outgoing network for a trigger condition for a client-side transaction. |
|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
local-ip
To configure a trigger condition in which the trigger is fired on the given local IP address, use the local-ip command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the local-ip address from the trigger condition, use the no form of this command.
Syntax Description
The interface IP address or hostname accepting incoming requests. |
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the local-listen IP address for the trigger condition:
The following example removes the local-listen IP address from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
local-port
To configure a trigger condition in which the trigger is fired on the given local-listen port, use the local-port command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the local-listen port from the trigger condition, use the no form of this command.
Syntax Description
Command Default
The local-listen port is not assigned to the trigger condition.
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the local-listen port for the trigger condition:
The following example removes the local-listen port from the trigger condition:
Related Commands
|
|
|
|---|---|
Assigns a local-listen IP address that accepts incoming requests to a trigger condition. |
|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
message
To determine whether the trigger condition will fire based on whether the headers in the SIP message are request or response headers, use the message command in trigger sequence configuration mode. To remove the message trigger from the trigger condition, use the no form of this command.
message { request | response }
Syntax Description
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the trigger to fire if the incoming message is a SIP request header:
The following example configures the trigger to fire if the incoming message is a SIP response header:
The following example removes the message field from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
method (trigger sequence)
To configure a trigger condition in which the trigger is fired on the given SIP method name in the request, use the method command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
The value of this command cannot be entered as a regular expression.
Examples
The following example configures the method name for the trigger condition to INVITE:
se-10-1-0-0(cusp-config-trigger-seq)> method INVITE
The following example removes the method name from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
mid-dialog
To configure the trigger to fire on mid-dialog responses, use the mid-dialog command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire on mid-dialog responses:
The following example configures the trigger to not fire on mid-dialog responses:
out-network
To configure the outgoing network for a trigger condition for a client-side transaction, use the out-network command in trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the out-network field for the network called “external” for the trigger condition:
The following example removes the out-network field from the trigger condition:
Related Commands
|
|
|
|---|---|
Configures the incoming network for a trigger condition for a server-side transaction. |
|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
protocol
To configure a trigger condition in which the trigger is fired on the specific protocol name, use the protocol command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
Syntax Description
Sets TCP as the transport protocol for the trigger condition. |
|
Sets TLS as the transport protocol for the trigger condition. |
|
Sets UDP as the transport protocol for the trigger condition. |
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger condition to use UDP as the transport protocol:
The following example removes the transport protocol from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
proxy-route header-param
To configure a trigger to fire when matching the regular expression for the specified header parameter, use the proxy-route header-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
proxy-route header-param header-param-name match-string
no proxy-route header-param header-param-name
Syntax Description
Specifies the name of the header parameter to match. This argument does not accept regular expressions. |
|
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire when the header parameter service-ref equals abczyx123:
The following example removes the header parameter from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 1
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
proxy-route uri-component
To configure a trigger to fire when matching the regular expression for the specified URI component, use the proxy-route uri-component command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
proxy-route uri-component host host | port port | scheme scheme | uri uri | user user
no proxy-route uri-component host host | port port | scheme scheme | uri uri | user user
Syntax Description
Specifies the value that the scheme URI component must match. |
|
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire when the user component equals 949:
The following example configures the trigger to fire when the scheme component equals sip:
The following example configures the trigger to fire when the host component equals 10.3.29.107:
The following example configures the trigger to fire when the port component equals 5060:
The following example configures the trigger to fire when the URI equals sip:9495550101@10.3.29.107:
The following example removes the user URI component from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 1
proxy-route uri-param
To configure a trigger to fire when matching the regular expression for the specified URI parameter, use the proxy-route uri-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
proxy-route uri-param uri-param-name match-string
no proxy-route uri-param uri-param-name
Syntax Description
Specifies the name of the URI parameter to match. This argument does not accept regular expressions. |
|
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire when the URI parameter transport equals tcp:
The following example removes the user URI parameter from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 1
remote-ip
To configure a trigger condition in which the trigger is fired on the specific remote IP address of the peer element, use the remote-ip command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the remote IP address from the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the remote IP address for the trigger condition:
The following example removes the remote IP address from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 20
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
remote-port
To configure a trigger condition in which the trigger is fired on the specific remote port number of the peer element, use the remote-port command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the remote port from the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Usage Guidelines
Examples
The following example configures the remote port for the trigger condition:
The following example removes the remote port from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
request-uri uri-component
To configure a trigger to fire when matching the regular expression for the specified URI component, use the request-uri uri-component command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
request-uri uri-component host host | port port | scheme scheme | uri uri | user user
no request-uri uri-component host host | port port | scheme scheme | uri uri | user user
Syntax Description
Specifies the value that the scheme URI component must match. |
|
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire when the user component equals 949:
The following example configures the trigger to fire when the scheme component equals sip:
The following example configures the trigger to fire when the host component equals 10.3.29.107:
The following example configures the trigger to fire when the port component equals 5060:
The following example configures the trigger to fire when the URI equals sip:9495550101@10.3.29.107:
The following example removes the user URI component from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 1
request-uri uri-param
To configure a trigger to fire when matching the regular expression for the specified URI parameter, use the request-uri uri-param command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
request-uri uri-param uri-param-name match-string
no request-uri uri-param uri-param-name
Syntax Description
Specifies the name of the URI parameter to match. This argument does not accept regular expressions. |
|
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger to fire when the URI parameter transport equals tcp:
The following example removes the user URI parameter from the trigger condition:
se-10-1-0-0(cusp-config-trigger)> sequence 1
response-code
To configure a trigger condition to fire on a specific response, use the response-code command Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the response code from the trigger condition, use the no form of this command.
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the response code for a trigger condition to 408:
The following example removes the response code from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
time
To configure the trigger to fire if the specified time policy is met, use the time command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the time policy, use the no form of this command.
Syntax Description
Specifies the time policy previously configured using the policy time command. |
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger-seq)
Command History
|
|
|
|---|---|
Examples
The following example configures the trigger condition t1 to fire when the time policy fridays is met:
The following example removes the the trigger condition using time policy:
Related CommandsTBD
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
user-agent-hdr
To configure a trigger condition to fire on the value of the User Agent header field, use the user-agent-hdr command in Cisco Unified SIP Proxy trigger sequence configuration mode. To remove the trigger condition, use the no form of this command.
user agent-hdr user-agent-hdr-value
no user agent-hdr user-agent-hdr-value
Syntax Description
Command Default
Command Modes
Cisco Unified SIP Proxy trigger sequence configuration (cusp-config-trigger)
Command History
|
|
|
|---|---|
Usage Guidelines
The value of this command is entered as a regular expression.
Examples
The following example configures the user agent header for a trigger condition:
The following example removes the user agent header from the trigger condition:
Related Commands
|
|
|
|---|---|
Creates a trigger condition and enters Cisco Unified SIP Proxy trigger configuration mode. |
Feedback