Cisco Unified Contact Center Express Command Line Interface Reference Guide, Release 9.0(2)
CLI Basics
Downloads: This chapterpdf (PDF - 1.14 MB) The complete bookPDF (PDF - 2.57 MB) | The complete bookePub (ePub - 251.0 KB) | Feedback

CLI Basics

CLI Basics

Start CLI session

You can access the Cisco Unified Contact Center Express (Unified CCX) CLI remotely or locally:

  • From a SSH-enabled client workstation, you can use SSH to connect securely to the Unified CCX.
  • You can access the Unified CCX 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 gets defined during installation:

  • A primary IP address and hostname
  • An administrator ID
  • A password

You will need this information to log in to the Cisco IPT Platform.

Perform the following steps to start a CLI session:

    Step 1   Do one of the following actions depending on your method of access:
    • From a remote system, use SSH to connect securely to the Cisco IPT Platform. In your SSH client, enter ssh adminname@hostname where adminname specifies the Administrator ID and hostname specifies the hostname that was defined during installation. For example, ssh admin@ipt-1.
    • From a direct connection, you receive this prompt automatically:
      ipt-1 login: 
      where ipt-1 represents the host name of the system. Enter your administrator ID.

    In either case, the system prompts you for a password.

    Step 2   Enter your password.

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


    Commands completion

    To complete commands, use Tab:

    • Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set gets completed.
    • Enter a full command name and press Tab to display all the commands or sub-commands that are available. For example, if you enter set and press Tab, you see all the set sub-commands. An * identifies the commands that have sub-commands.
    • If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.

    Get help on commands

    You can get two kinds of help on any command:

    • Detailed help that includes a definition of the command and an example of its use
    • Short query help that includes only command syntax

    To get detailed help, at the CLI prompt, enter

    help command

    Where command specifies the command name or the command and parameter. See Example 1 .


    If you enter the help command without specifying the name of a particular command as the optional parameter, the system provides information about the CLI system.

    To query only command syntax, at the CLI prompt, enter

    command ?

    Where command represents the command name or the command and parameter. See Example 2 .


    If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.

    Detailed Help Example:

    admin:help file list activelog activelog help: This will list active logging files options are: page - pause output detail - show detailed listing reverse - reverse sort order date - sort by date size - sort by size file-spec can contain '*' as wildcards Example: admin:file list activelog platform detail 02 Dec,2004 12:00:59 <dir> drf 02 Dec,2004 12:00:59 <dir> log 16 Nov,2004 21:45:43 8,557 enGui.log 27 Oct,2004 11:54:33 47,916 startup.log dir count = 2, file count = 2

    Query Example:

    admin:file list activelog?Syntax: file list activelog file-spec [options] file-spec mandatory file to view options optional page|detail|reverse|[date|size]

    Exit command with Ctrl-C key sequence

    You can stop most interactive commands by entering the Ctrl-C key sequence, as shown in the following example:

    Exiting a Command with Ctrl-C

    admin:utils system upgrade initiate Warning: Do not close this window without first exiting the upgrade command. Source: 1) Remote Filesystem 2) DVD/CD q) quit Please select an option (1 - 2 or "q"): Exiting upgrade command. Please wait... Control-C pressed admin:


    If you execute the command utils system switch-version and enter Yes to start the process, entering Ctrl-C exits the command but does not stop the switch-version process.

    End CLI session

    At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.

    Unavailable CLI commands for Unified CCX

    There are few CLI commands that are either unavailable or not applicable in Unified CCX as they are not applicable for Unified CCX.

    These CLI commands are as follows:

    • delete dscp – Unavailable
    • file delete license – Unavailable
    • file get license – Unavailable
    • file list license – Unavailable
    • file view license – Unavailable
    • Set cert bulk – Unavailable
    • set dscp – Unavailable
    • set network cluster publisher – Unavailable
    • set network dhcp – Unavailable
    • set network hostname – Unavailable
    • set network ipv6 dhcp – Unavailable
    • set network ipv6 service – Unavailable
    • set network ipv6 static_address – Unavailable
    • Show ctl – Unavailable
    • Show dscp – Unavailable
    • Show itl – Unavailable
    • show network ipv6 settings – Unavailable
    • show tech ccm_services – Renamed to show tech uccx_services
    • show uccx tech dbschemaversion – Unavailable
    • run loadxm – Unavailable
    • Utils sso – Unavailable


    For detailed information on all the CLI commands available for the Cisco Unified Communications Operating System, refer to Command Line Interface Reference Guide for Cisco Unified Communications Solutions available here: