CLI Command Reference for Cisco Unified SIP Proxy Release 9.0

 

Syntax Description

 

Command Default

Standard

 

Command History

 

Usage Guidelines

The type of socket used for the network interface has different characteristics:

• Standard

– The network interface has full UDP support.

– The network interface supports ICMP.

– Different sockets can be used for each endpoint.

• ICMP

– The network interface supports ICMP.

• No ICMP

– No ICMP errors are supported.

– The network does not use a separate socket for each endpoint.

• NAT

– The network interface supports NAT.

Caution After a SIP network is created, it cannot be removed.

---

Examples

The following example configures a standard network and enters SIP network configuration mode:

The following example configures a SIP network to support ICMP:

The following example configures the SIP network interface so that ICMP errors are not supported:

 

Related Commands

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

TCP/TLS client connections on the SIP network are enabled by default.

 

Command History

Examples

The following example allows TCP/TLS connections on a standard SIP network named “internal”:

The following example disables TCP/TLS connections on a standard SIP network named “internal”:

 

Related Commands

 

Syntax Description

 

Command History

 

Command Default

The header value is not masked.

 

Usage Guidelines

The only valid header name in Cisco Unified SIP Proxy version 1.0 is via.

Examples

The following example configures the SIP network to mask the Via header:

The following example configures the SIP network to not mask the Via header:

 

Related Commands

 

Syntax Description

 

Command History

 

Command Default

udp max-datagram-size : 1500

 

Usage Guidelines

If a packet on the network is larger than this specified size, the message is upgraded to TCP if there exists a TCP listening point configured for the network.

Examples

The following example configures the maximum size of a UDP datagram to 2000 bytes for this network:

 

Related Commands

 

Syntax Description

 

Command Default

The sending of 100 responses to non-INVITE requests is disabled.

 

Command History

 

Usage Guidelines

Use this command to configure SIP networks with TU3 transmission type only. If you enable the sending of 100 responses to nonINVITE requests, you must specify a TU3 timer.

Examples

The following example enables the sending of 100 responses to non-INVITE requests, and sets the TU3 timer value to 200:

The following example disables the sending of 100 responses to non-INVITE requests

 

Related CommandsTBD

 

Syntax Description

 

Command Default

The default value for each retransmit count type is as follows:

• invite-client-transaction —3
• invite-server-transaction —3
• non-invite-client-transaction —3

 

Command History

 

Usage Guidelines

The retransmission count values specify the maximum number of allowable SIP retransmissions. The value of a specific count can be set different for different networks if a network has different transmission latency characteristics. For more information about retransmission counts using SIP, see RFC 3261.

Examples

The following example configures the invite-client retransmit count to 5:

The following example configures the client retransmit count to 18:

The following example restores the default value of the invite-client count.

 

Related Commands

 

Syntax Description

 

Command Default

The default value for each retransmit timer is as follows:

• T1 —500 milliseconds
• T2 —4,000 milliseconds
• T4 —5,000 milliseconds
• serverTn —64,000 milliseconds
• clientTn —64,000 milliseconds
• TU1 —5,000 milliseconds
• TU2 —32,000 milliseconds

 

Command History

 

Usage Guidelines

The retransmission timer values define the duration of SIP retransmissions. The value of a specific timer can be set differently for different networks if a network has different transmission latency characteristics. For more information about retransmission timers using SIP, see RFC 3261.

Examples

The following example configures the T1 retransmission timer to 1,000 milliseconds.

The following example restores the default value of the TU1 retransmission timer.

 

Related Commands

 

Syntax Description

By default, the TLS Verify command is enabled.

 

Command History

 

Usage Guidelines

Use this command to enable the following certificate type validation:

• tls verify type client-auth—This enables the client certificate authentication for TLS connections. The client certificate validation is applicable for incoming TLS connections to cusp.
• tls verify type server-auth—This enables the server certificate authentication for TLS connections. The server certificate validation is applicable for outgoing TLS connections from cusp.

Examples

The following example enables the both server and client certificate authentication:

The following example enables the server certificate authentication and client certificate authentication is disabled:

The following example enables the client certificate authentication and server certificate authentication is disabled:

The following example disables certificate verification:

 

Related Commands

 

Syntax Description

 

Command Default

The listener on the SIP network is not enabled.

 

Command History

 

Usage Guidelines

A listener is an interface, port, and transport tuple that the server listens on for incoming packets. Multiple listeners can be configured for a single server; however, at least one must be established for the server to accept SIP traffic. A network can have multiple listeners. You do not have to disable listeners on the network when you make configuration changes to the network.

Caution You cannot run TCP and TLS listeners on the same port.

---

Caution Do not enable the sip listen command until you complete all of the other configuration tasks. After you enable the command, the system starts receiving incoming requests from the specified SIP network.

---

Examples

The following example configures the listener on a SIP network named “external” that uses the TCP:

The following example configures the listener on a SIP network named “internal” that uses the UDP:

The following example disables a listener on a SIP network:

 

Related Commands

 

Syntax Description

 

Command Default

None

 

Command History

 

Usage Guidelines

Record-routing ensures that all SIP messages within a dialog traverse the same route. The SIP Record-Route header field contains configurable interface, port, and transport values, which forces messages to pass through the desired SIP entity. The Record-Route feature is critical for directing messages to a load balancer that is managing SIP traffic for a group of servers.

Examples

The following example enables record-routing for a SIP network named “internal”:

The following example enables record-routing for a SIP network named “external”:

The following example disables record-routing for a SIP network named “external”:

 

Related Commands

 

Syntax Description

 

Command Default

70

 

Command History

 

Usage Guidelines

The Max-Forwards header field of a SIP request specifies the maximum number of times the request can be forwarded to another server. Each time a request is received by a server, this value is decremented by one. (If the request does not have a Max-Forwards header, one is added.) When the value reaches zero, the server responds with a 483 (Too Many Hops) response and terminates the transaction.

You can use the Max-Forwards header field to detect forwarding loops within a network.

Note We recommend that you set this command to a value greater than or equal to 10, and less than or equal to 100.

Examples

The following example configures the value of the SIP Max-Forwards header field to 100:

 

Related Commands

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

SIP header compaction is disabled.

 

Command History

 

Usage Guidelines

When enabled, compact header forms are used for the following SIP headers:

• Call-ID
• Contact
• Content-Encoding
• Content-Length
• Content-Type
• From
• Subject
• To
• Via

When header compaction is disabled, complete SIP headers are used in all outgoing messages, regardless of the header format.

Examples

The following example enables SIP header compaction:

The following example disables SIP header compaction:

 

Related Commands

 

Syntax Description

 

Command Default

The default port is 5060, and the default transport protocol is UDP.

 

Command History

 

Usage Guidelines

This command configures the behavior of the server when it is overloaded. There are two behavior modes: reject and redirect. Use the sip overload redirect command to configure redirect mode and the sip overload reject command to configure reject mode. Only one mode can be configured at a time.

If reject mode is configured, the proxy rejects messages and responds with a 503 (Server Unavailable) response when overloaded.

If redirect mode is cconfigured, the proxy redirects messages and responds with a 300 (Redirect) response when overloaded.

Examples

The following example configures the server to send a 300 (Redirect) response when the server is overloaded:

The following example disables the server from sending a 300 (Redirect) response when the server is overloaded:

 

Related Commands

 

Syntax Description

 

Command Default

The default value is 0.

 

Command History

 

Usage Guidelines

This command configures the behavior of the server when it is overloaded. There are two behavior modes: reject and redirect. Use the sip overload redirect command to configure redirect mode and the sip overload reject command to configure reject mode. Only one mode can be configured at a time.

If reject mode is configured, the proxy rejects messages and responds with a 503 (Server Unavailable) response when overloaded.

If redirect mode is cconfigured, the proxy redirects messages and responds with a 300 (Redirect) response when overloaded.

Examples

The following example configures the server to send a 503 (Server Unavailable) response when the server is overloaded:

The following example configures the server to send a 503 (Server Unavailable) response when the server is overloaded and sets the retry-after-time to 60 seconds:

The following example disables the server from sending a 503 (Server Unavailable) response when the server is overloaded:

 

Related Commands

 

Syntax Description

 

Command Default

30 minutes

 

Command History

Examples

The following example configures the SIP TCP connection timeout value to 120 minutes:

 

Related Commands

 

Syntax Description

 

Command Default

The maximum number of TCP/TLS connections allowed is 256.

 

Command History

 

Usage Guidelines

When the maximum number of TCP/TLS connections is reached, passive (incoming) connections are not accepted, and additional active (outgoing) connections can be made.

Examples

The following example configures the maximum number of TCP/TLS connections to 512:

 

Related Commands

 

Syntax Description

 

Command Default

None

 

Command History

 

Usage Guidelines

The SIP queues are created by the proxy during runtime. The queue gets created by the proxy with the default values as the service gets activated. The command fails if the queue does not yet exist. To verify what SIP queues have been created, use the show status queue command.

Examples

The following example enters SIP queue configuration mode to configure the timer queue:

The following example enters SIP queue configuration mode to configure the st-callback queue:

The following example sets all the SIP RADIUS queue parameters back to their default values:

 

Related Commands

 

Syntax Description

 

Command Default

The head drop policy is used.

 

Command History

Examples

The following example configures the drop policy in the SIP message queue to the head setting:

The following example configures the drop policy in the SIP st-callback queue to the tail setting:

The following example configures the drop policy in the radius queue to the unbounded setting:

The following example returns the drop-policy for the RADIUS queue to the default value:

 

Related Commands

 

Syntax Description

 

Command Default

80 percent

 

Command History

 

Usage Guidelines

The low-water mark value specifies the capacity at which the server is no longer considered overloaded, and starts accepting new events.

Examples

The following example configures the low-water mark for the SIP message queue to 100 percent:

The following example configures the low-water mark for the RADIUS queue to 50 percent:

The following example returns the low-water mark for the ct-callback queue to the default value:

 

Related Commands

 

Syntax Description

 

Command Default

2,000

 

Command History

 

Usage Guidelines

Caution Setting this parameter to a large value must be carefully evaluated because the memory consumed is directly proportional to this queue size.

---

Examples

The following example configures the message queue size to 10,000:

The following example configures the radius queue size to 5,000:

The following example returns the radius queue size to the default value:

 

Related Commands

 

Syntax Description

 

Command Default

20 threads are allocated to the SIP queue.

 

Command History

Examples

The following example configures the thread count for the SIP message queue to 40:

The following example returns the message queue thread count to the default value:

 

Related Commands

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

None

 

Command History

 

Usage Guidelines

When there is no server-group configured for a given hostname, the system first attempts the DSN resolution using /etc/hosts. If this fails, then the system uses DNS lookup. Commands in the SIP DNS SRV configuration submode configure the DNS NAPTR/SRV lookup related information.

Examples

The following example enters SIP DNS SRV configuration mode:

 

Related CommandsTBD

 

Syntax Descriptionno sip 100-response

This command has no arguments or keywords.

 

Command Default

Using DNS server SRV query records is disabled.

 

Command History

 

Usage Guidelines

When this command is disabled, the use of DNS servers NAPTR/SRV records is disabled and only simple naming resolution is performed using the operating system’s DNS configuration. DNS SRV (RFC 3263) is used for Cisco Unified SIP Proxy load balancing.

Examples

The following example enables the use of DNS server SRV query records:

The following example disables the use of DNS server SRV query records:

 

Related Commands

 

Syntax Descriptionno sip 100-response

This command has no arguments or keywords.

 

Command Default

The use of DNS NAPTR for domain name/IP address mapping is disabled.

 

Command History

Examples

The following example enables the use of DNS NAPTR for hostname/IP address mapping:

The following example disables the use of DNS NAPTR for hostname/IP address mapping:

 

Related CommandsBD

 

Syntax Description

 

Command Default

None

 

Command History

Examples

The following example adds cusp.example.com to the hostname list:

The following example removes cusp.example.com from the server’s hostname list:

 

Related CommandsTBD

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

SIP logging is disabled.

 

Command History

 

Usage Guidelines

Turning on SIP logging has a significant performance impact on Cisco Unified SIP Proxy.

Examples

The following example enables the logging of all incoming and outgoing SIP messages:

The following example disables the logging of all incoming and outgoing SIP messages:

 

Related Commands

 

Syntax Description

 

Command Default

SIP peg counting is disabled.

 

Command History

 

Usage Guidelines

Enabling SIP peg counting has a noticeable performance impact on Cisco Unified SIP Proxy, although not as much of an impact as enabling SIP logging.

Examples

The following example enables SIP transaction peg counting every 60 seconds:

The following example disables SIP transaction peg counting:

 

Related Commands

 

Syntax Description

 

Command Default

All peers are untrusted.

 

Command History

 

Usage Guidelines

Use this command to configure the conditions for trusted-peers for "id" privacy service. Cisco Unified SIP Proxy removes P-Asserted-Identity headers from the request if the request is from a untrusted peer; and it removes P-Asserted-Identity from the request if the request it to be sent to a untrusted peer. Privacy service is provided for Diversion headers as well, following draft-levi-sip-diversion-08.txt

Examples

The following example configures the destination as a trusted peer if the in-network condition is met:

The following example configures all destinations as untrusted unconditionally:

 

Related Commands

 

Syntax Description

 

Command Default

All peers are untrusted.

 

Command History

 

Usage Guidelines

Use this command to configure the conditions for trusted-peers for "id" privacy service. CUSP removes P-Asserted-Identity headers from the request if the request is from a untrusted peer; and it removes P-Asserted-Identity from the request if the request it to be sent to a untrusted peer. Privacy service is provided for Diversion headers as well, following draft-levi-sip-diversion-08.txt

Examples

The following example configures all sources as trusted unconditionally and assigns the value to sequence 1:

The following example configures all sources as untrusted unconditionally:

 

Related Commands

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

SIP privacy service is enabled.

 

Command History

 

Usage Guidelines

Since the Cisco Unified SIP Proxy implements "id" privacy (RFC 3325) only, if privacy values contain any one of "session", "user" or "header", and it also contains "critical", Cisco Unified SIP Proxy returns 500 response following RFC 3323 if the SIP privacy service is enabled.

Examples

The following example enables SIP privacy service:

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

SIP TLS is not enabled.

 

Command History

 

Usage Guidelines

Use this command before configuring a SIP listener that uses the TLS transport.

Use this command to enable the use of SIP TLS connections with any other SIP entities, providing secure communications over the network. By default, TLS connections are accepted from all requesting clients with whom the Cisco Unified SIP Proxy has a trusted certificate. This is useful only when data encryption is desired and trust relationships are not required.

TLS encryption requires the two participating parties to specify a keystore and a corresponding trust certificate. When TLS is enabled, the system reads the key store files. As a result, before enabling the sip tls command, the keystore must first be created using the cypto key generate command.

Cisco Unified SIP Proxy supports both one-way and two-way TLS.

Note If there are active SIP listeners with the TLS transport enabled, then this command cannot be disabled.

Examples

The following example enables the use of SIP TLS connections:

The following example disables the use of SIP TLS connections:

 

Related Commands

 

Syntax Description

 

Command Default

None

 

Command History

 

Usage Guidelines

The establishment of TLS connections fails unless the identity of the remote side matches the identifier of a configured trusted peer. If there are no trusted peers configured, the connection is accepted as long as the TLS handshake succeeds.

Examples

The following example configures example.com as a TLS trusted peer:

The following example removes example.com as a TLS trusted peer:

 

Related CommandsTBD

 

Syntax Description

This command has no arguments or keywords.

 

Command Default

Route recursion is enabled by default.

 

Command History

 

Usage Guidelines

When the Cisco Unified SIP Proxy receives a redirect response (that is, any 3xx response), it can be configured to recursively perform its routing logic on the received Contacts. A received Contact is placed into the Request URI of the prenormalized incoming request, and the server’s routing and postnormalization logic is executed based on the new destination. If multiple Contacts are received, they are processed sequentially based on their configured q-values. If more than one contacts have the same q-value, they are processed sequentially in order of the appearance.

Examples

The following example enables route recursion on the Cisco Unified SIP Proxy:

The following example disables route recursion on the Cisco Unified SIP Proxy:

 

Related CommandsTBD