Using Cisco Contact Center SIP Proxy (CCCSP) Software

Understanding Command Modes

The CCCSP application command environment is divided into four modes:

  • System EXEC mode—This is the mode that you get into when you log into CCCSP via the terminal console or ssh access using the CCCSP Administrator credentials.

  • System Configuration mode—You enter into this mode using the configure terminal command from System EXEC mode. This mode permits you to make system configuration changes, 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.

  • CCCSP Management mode—Use the cusp command in system EXEC mode and enter into CCCSP management mode. This mode includes commands that allow you to display the CCCSP configuration for diagnostic and troubleshooting purposes.

  • CCCSP Configuration mode—Use the configure command in CCCSP management mode to enter into CCCSP configuration mode. This mode permits you to make configuration changes to the Cisco Contact Center SIP Proxy (CCCSP). CCCSP uses the “candidate configuration” and the “active configuration” concepts.

    • Candidate configuration: When you make configuration changes for the CCCSP, these changes are stored in the candidate configuration. While in the candidate configuration state, these configuration parameters do not take effect.

    • Active configuration: The active configuration includes all configuration parameters that are currently effective on the CCCSP.

      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 CCCSP configuration mode allow you to display the current candidate and active configurations. In CCCSP Management mode only the active configuration can be displayed.

      CCCSP 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 depends 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 environment mode of each command.

Start CLI Session

You can access Cisco Contact Center SIP Proxy (CCCSP) remotely or locally:

  • From a web client workstation, such as the workstation that you use for Cisco Operating System Administration, you can use SSH to connect securely to the Cisco Operating System.

  • You can access the Cisco Operating System CLI directly by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.

Before you begin

Ensure you have the following information that is defined during installation:

  • A primary IP address and hostname

  • A root account

  • A platform administrator account

  • A GUI Administrator account

  • User ID and password credentials of these accounts

Procedure

Step 1

You have three different options to SSH to CCCSP. Perform one of the following actions depending on your method of access:

  1. From a remote system using root account, use SSH to connect securely to the Cisco Operating System. In your SSH client, enter 

    ssh root@<CCCSP IP>

    where root specifies the root account ID and CCCSP IP specifies the IP address of CCCSP system.

    For example, ssh root@10.10.10.10

  2. From a remote system using platform administrator account, enter SSH in your client as follows: 

    ssh platformadminaccount@<CCCSP IP>

    where, platformadminaccount specifies the platform administrator account ID. Enter the platform administrator ID that was defined during installation.

  3. From a remote system using GUI administrator account, enter SSH in your client as follows: 

    ssh GUIAdminAccount@<CCCSP IP>

    where, GUIAdminAccount specifies the GUI administrator account ID.

    You enter the CCCSP configuration mode when using the GUI Account.

Step 2

Enter the password that was defined at installation.

The CLI prompt displays. The prompt represents the Administrator ID; for example: 

admin:

You can now use any CLI command.

Enter the Command Environment

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

Before you begin

Gather the following information:

  • IP address of the router that contains the CCCSP module

  • Username and password to log in to the router

  • Slot number of the module

SUMMARY STEPS

  1. Open an SSH session.
  2. SSH username@ip-address
  3. Password:
  4. cusp
  5. configure

DETAILED STEPS

  Command or Action Purpose

Step 1

Open an SSH session.

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

Step 2

SSH username@ip-address

Example:

ssh cusp@10.10.10.234

Specifies the username and IP address of the CCCSP.

Step 3

Password:

Enter your password credentials for CCCSP.

Step 4

cusp

Example:

Hostname# cusp
Hostname(cusp)#

Enters CCCSP management mode.

Step 5

configure

Example:

Hostname(cusp)# configure
Hostname(cusp-config)#

Enters CCCSP 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 1. 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.

Save Configuration Changes

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

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

Syntax Description

sftp:user-id:password@

User ID and password for the SFTP server. Include the colon (:) and the at sign (@) in your entry.
sftp-server-address

IP address of the SFTP server.
/ directory

(Optional) Directory on the SFTP 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

Usage Guidelines

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. 


Hostname# copy running-config startup-config start

When you copy the running configuration to an SFTP 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 SFTP server, which requires a user ID and password. The IP address of the SFTP server is 172.11.111.193. The running configuration is copied to the config directory as a file called saved_start. 


Hostname# copy running-config sftp:
Address or name of remote host? admin:voice@172.11.111.193/configs
Source filename? saved_start

Note

CCCSP has additional requirements for saving configuration changes for some commands. See Committing Configuration Changes.

Commit Configuration Changes

Unlike other Linux-based applications supported on Cisco Integrated Services Routers, CCCSP 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 CCCSP configuration mode, you are asked whether you want to commit your changes. If you answer no, all your changes are discarded.