Using Cisco Unified SIP Proxy Software

This chapter provides helpful tips for understanding and configuring Cisco Unified SIP Proxy software using the command-line interface (CLI). It contains the following sections:

Understanding Command Modes

The Cisco Unified SIP Proxy CLI commands have a structure very similar to that of Cisco IOS CLI commands. However, the Cisco Unified SIP Proxy CLI commands do not affect Cisco IOS configurations. After you have logged in to the Cisco Unified SIP Proxy module, the command environment is no longer the Cisco IOS environment.

The Cisco Unified SIP Proxy module command environment is divided into four modes:

  • Module EXEC—This is the mode that you are in after you log in to the Cisco Unified SIP Proxy network or service module. The module EXEC commands affect the system's parameters in different ways. Some commands only display or clear parameter values, stop or start the entire system, or start troubleshooting procedures. However, unlike Cisco IOS EXEC mode, the module EXEC mode has a few commands that change parameter values. These changes are stored in the module’s memory, rather than in the startup configuration, so that the system has some minimum information available if a catastrophic event, such as a power or disk failure, occurs.
  • Configuration—This mode permits you to make system configuration changes for the module, which are stored in the running configuration. If you later save the running configuration to the startup configuration, the changes made with the configuration commands are restored when the software is rebooted.
  • Cisco Unified SIP Proxy EXEC—This is the mode that you are in after you log in to the Cisco Unified SIP Proxy command environment. Cisco Unified SIP Proxy EXEC commands affect the system’s parameters in different ways. This mode includes commands that allow you to display the Cisco Unified SIP Proxy configuration for diagnostic and troubleshooting purposes.
  • Cisco Unified SIP Proxy Configuration—This Cisco Unified SIP Proxy Configuration—This mode permits you to make configuration changes to the Cisco Unified SIP Proxy. Unlike other Linux-based applications that are supported on the Cisco Integrated Services Routers, Cisco Unified SIP Proxy does not use the concept of a running configuration. Instead, the Cisco Unified SIP Proxy uses the concepts of the “candidate configuration” and the “active configuration.”

–blank.gif Candidate configuration: When you make configuration changes for the Cisco Unified SIP Proxy, these changes are stored in the candidate configuration. While in the candidate configuration state, these configuration parameters do not take effect.

–blank.gif Active configuration: The active configuration includes all configuration parameters that are currently effective on the Cisco Unified SIP Proxy.

note.gif

Noteblank.gif Module EXEC and configuration modes do use the concept of a running configuration. Only the Cisco Unified SIP Proxy modes do not use this concept.

To enable configuration changes to take effect, you must enter the commit command. After you enter the commit command, all configuration changes in the candidate configuration become part of the active configuration. Separate commands in Cisco Unified SIP Proxy configuration mode allow you to display the current candidate and active configurations. In Cisco Unified SIP Proxy EXEC mode only the active configuration can be displayed.

Cisco Unified SIP Proxy configuration mode has some subconfiguration levels. The global configuration mode changes the command environment from EXEC to configuration. You can modify many software parameters at this level. However, certain configuration commands change the environment to more specific configuration modes where modifications to the system are entered. For example, the trigger condition command changes the environment from config to config-trigger. At this point, you can enter or modify application parameter values.

The commands available to you at any given time depend on the mode that you are currently in. Entering a question mark (?) at the CLI prompt displays a list of commands available for each command mode. The descriptions in this command reference indicate each command’s environment mode.

Table 1 describes how to access and exit various common command modes of the Cisco Unified SIP Proxy software. It also shows examples of the prompts displayed for each mode.

Table 1 Accessing and Exiting Command Modes

Command Mode
Access Method
Prompt
Exit Method

Module EXEC

When the integrated services engine module software prompt appears, enter the enable command. If a password has been configured, enter the password at the password: prompt.
se-10-0-0-0#>

Press CTRL-SHIFT-6, and then enter x.

Module configuration

From module EXEC mode, enter the configure terminal command.
se-10-0-0-0#(config)>

To return to module EXEC mode from the module configuration mode, use the end or exit command.

Cisco Unified SIP Proxy EXEC

From module EXEC mode, enter the cusp command.
se-10-0-0-0#(cusp)>

To return to module EXEC mode from Cisco Unified SIP Proxy EXEC mode, use the end or exit command.

Cisco Unified SIP Proxy configuration

From Cisco Unified SIP Proxy EXEC mode, use the configure command.
se-10-0-0-0(cusp-config)>

To return to Cisco Unified SIP Proxy EXEC mode from Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Accounting

From Cisco Unified SIP Proxy configuration mode, use the accounting command.
se-10-0-0-0(cusp-config-
acct)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Policy lookup

From Cisco Unified SIP Proxy configuration mode, use the policy lookup policy-name command.
se-10-0-0-0(cusp-config-lookup)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Policy lookup sequence field and sequence header

From Cisco Unified SIP Proxy policy lookup configuration mode, entering one of the following commands takes you into the sequence field or sequence header configuration modes:

  • sequence sequence-number table-name field { in-network | local-address | remote-address }
  • sequence sequence-number table-name header { diversion | from | paid | rpid | ruri } uri-component {domain | param name | phone | uri | user}
se-10-0-0-0(cusp-config-lookup-
seq)>

To return to Cisco Unified SIP Proxy policy lookup configuration mode, use the end or exit command.

Policy normalization

From Cisco Unified SIP Proxy configuration mode, use the policy normalization policy_name command.
se-10-0-0-0(cusp-config-norm)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Policy time

From Cisco Unified SIP Proxy configuration mode, use the policy time time_policy_name command.
se-10-0-0-0(cusp-config-time)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Policy time sequence

From Cisco Unified SIP Proxy policy time configuration mode, use the sequence sequence-number command.
se-10-0-0-0(cusp-config-time-seq)>

To return to Cisco Unified SIP Proxy policy time configuration mode, use the end or exit command.

RADIUS server group

From Cisco Unified SIP Proxy configuration mode, use the server-group radius servergroup name [ source-ipaddress ] command.
se-10-0-0-0(cusp-config-radius)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Route group

From Cisco Unified SIP Proxy configuration mode, use the route group route-group name [ time-policy ] [ weight ] command.
se-10-0-0-0(cusp-config-rg)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Element

From Cisco Unified SIP Proxy route group configuration mode, use the element route-uri or element target-destination command.
se-10-0-0-0(cusp-config-rg-
element)>

To return to Cisco Unified SIP Proxy route group configuration mode, use the end or exit command.

Route table

From Cisco Unified SIP Proxy configuration mode, use the route table table_name command.
se-10-0-0-0(cusp-config-rt)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

SIP DNS server

From Cisco Unified SIP Proxy configuration mode, use the sipdns-serv command.
se-10-0-0-0(cusp-config-dns)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

SIP server group

From Cisco Unified SIP Proxy configuration mode, use the server-group sip servergroup-name command.
se-10-0-0-0(cusp-config-sg)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

SIP server group ping-options

From Cisco Unified SIP Proxy configuration mode, use the server-group sip ping-options network ip-address [ port ] command.
se-10-0-0-0(cusp-config-ping)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

SIP network

From Cisco Unified SIP Proxy configuration mode, use the sip network network { standard | icmp | noicmp } command.
se-10-0-0-0(cusp-config-
network)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

SIP queue

From Cisco Unified SIP Proxy configuration mode, use the sip queue { message | request | st-callback | ct-callback | timer | xcl | radius } command.
se-10-0-0-0(cusp-config-queue)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Trigger

From Cisco Unified SIP Proxy configuration mode, use the trigger condition trigger-condition-name command.
se-10-0-0-0(cusp-config-
trigger)>

To return to Cisco Unified SIP Proxy configuration mode, use the end or exit command.

Trigger sequence

From trigger configuration mode, use the sequence sequence-number command.
se-10-0-0-0(cusp-config-
trigger-seq)>

To return to Cisco Unified SIP Proxy trigger configuration mode, use the end or exit command.

Entering the Command Environment

Use this procedure to enter the different modes in the command environment.

Prerequisites

Gather the following information:

  • IP address of the router that contains the Cisco Unified SIP Proxy module
  • Username and password to log in to the router
  • Slot number of the module

SUMMARY STEPS

1.blank.gif Open a Telnet session.

2.blank.gif telnet ip-address

3.blank.gif Enter the user ID and password of the router.

4.blank.gif service-module integrated-service-engine slot/port session

5.blank.gif cusp

6.blank.gif configure

DETAILED STEPS

 

Command or Action
Purpose

Step 1

Open a Telnet session.

Use a DOS window, a secure shell, or a software emulation tool such as Reflection.

Step 2
telnet ip-address
 
C:\> telnet 172.16.231.195

Specifies the IP address of the Cisco Unified SIP Proxy router.

Step 3
Username:
Password:

Enter your user ID and password for the router.

Step 4
service-module integrated-service-engine slot/port session
 
Router# service-module integrated- service-engine 1/0 session

Enters the Cisco Unified SIP Proxy command environment using the module located in the specified slot and port. The prompt changes to “se” with the IP address of the Cisco Unified SIP Proxy module.

Note If the message “Trying ip-address slot/port ... Connection refused by remote host” appears, enter the command service-module integrated-service-engine slot/port session clear and try Step 4 again.

Step 5
cusp
 
se-10-0-0-0# cusp
se-10-0-0-0(cusp)>

Enters Cisco Unified SIP Proxy EXEC mode.

Step 6
configure
 
se-10-0-0-0(cusp)> configure
se-10-0-0-0(cusp-config)>

Enters Cisco Unified SIP Proxy configuration mode. You are ready to begin the configuration tasks.

Getting Help

Entering a question mark at the CLI prompt displays a list of commands available for each command mode. You can also get a list of keywords and arguments associated with any command by using the context-sensitive help feature.

To get help specific to a command mode, a command, a keyword, or an argument, use one of the commands in Table 2 .

 

Table 2 Help Commands
Command
Purpose
help

Provides a brief description of the help system in any command mode.
?

Lists all the commands that are available for a specific command mode.
<command_name> ?

Lists the keywords or arguments that you must enter next on the command line.

Note There is a space between the command and the question mark.
<abbreviated_command_entry> ?

Provides a list of commands that begin with a particular character string.

Note There is no space between the command and the question mark.
< abbreviated_command_entry> < Tab >

Completes a partial command name.

Enter the beginning of a command name and press Tab. The system automatically adds the rest of the command name.

Using the no and default Forms of Commands

Where available, use the no form of a command to disable a function. Use the command without the no keyword to reenable a disabled function or to enable a function that is disabled by default. The command reference entry for each command provides the complete syntax for the configuration commands and describes what the no form of a command does.

Configuration commands can also have a default form, which returns the command settings to the default values. In those cases where a command is disabled by default, using the default form has the same result as using the no form of the command. However, some commands are enabled by default and have variables set to certain default values. In these cases, the default form of the command enables the command and sets the variables to their default values. Where available, the command reference entry describes the effect of the default form of a command if the command functions differently than the no form.

Saving Configuration Changes

Starting in module EXEC mode, use the following command to copy the running configuration in flash memory to another location:

copy running-config {ftp:user-id:password@ftp-server-address[/directory] |
startup-config | tftp:tftp-server-address} filename

 

Keyword or Argument
Description

ftp: user-id : password @

User ID and password for the FTP server. Include the colon (:) and the at sign (@) in your entry.

ftp-server-address

IP address of the FTP server.

/ directory

(Optional) Directory on the FTP server where the copied file will reside. If you use it, precede the name with the forward slash (/).

startup-config

Startup configuration in flash memory.

tftp: tftp-server-address

IP address of the TFTP server.

filename

Name of the destination file that will contain the copied running configuration.

When you copy the running configuration to the startup configuration, enter the command on one line. In the following example, the running configuration is copied to the startup configuration as file start. In this instance, enter the command on a single line.

se-10-0-0-0# copy running-config startup-config start

When you copy the running configuration to an FTP or TFTP server, this command becomes interactive and the system prompts you for information. You cannot enter the parameters on one line. The following example illustrates this process. In the following example, the running configuration is copied to an FTP server, which requires a user ID and password. The IP address of the FTP server is 172.16.231.193. The running configuration is copied to the configs directory as a file called saved_start.

se-10-0-0-0# copy running-config ftp:
Address or name of remote host? admin:voice@172.16.231.193/configs
Source filename? saved_start
caut.gif
Caution blank.gif Cisco Unified SIP Proxy has additional requirements for saving configuration changes for some commands. See the “Committing Configuration Changes” section.

Committing Configuration Changes

Unlike other Linux-based applications supported on Cisco Integrated Services Routers, Cisco Unified SIP Proxy requires that you use the commit command for selected commands before the configuration changes take effect. If you do not use the commit command, any changes to these commands are not reflected in the active configuration.

The requirement for issuing the commit command applies to the following configuration commands (and the commands in their respective submodes):

  • policy lookup
  • policy normalization
  • policy time
  • route group
  • route table
  • route table file
  • server-group sip group

When you exit Cisco Unified SIP Proxy configuration mode, you are asked whether you want to commit your changes. If you answer no, all your changes are discarded.

Identifying Supported Platforms

Cisco IOS software is packaged in feature sets consisting of software images that support specific platforms. Specific software images are required to support the Cisco Unified SIP Proxy module hardware. The feature sets available for a specific platform depend on which Cisco IOS software images are included in a version. To identify the set of software images available in a specific version or to find out if a feature is available in a given Cisco IOS software image, use Cisco Feature Navigator. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. You do not need an account on Cisco.com.

Commercial Open Source Licensing

Some components of the software created for Cisco Unified SIP Proxy Release 9.0 are provided through open source or commercial licensing. These components and the associated copyright statements can be found at http://www.cisco.com/en/US/docs/voice_ip_comm/cusp/rel9_0/licensing/ipcentral.pdf.