Command Line Interface Basics
Start CLI Session
Access the Cisco Unified Contact Center Express (Unified CCX) Command Line Interface (CLI) either remotely or locally using one of these two methods:
- From an SSH-enabled client workstation, use SSH to connect securely to the Unified CCX.
- Access the Unified CCX CLI directly or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.
To start a CLI session:
Perform one of the following tasks:
In either case, the system prompts you for a password.
The CLI prompt displays. The prompt represents the administrator ID, for example:
Get Help with Commands
You can get two kinds of help for 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
where command specifies the command name or the command and parameter.
Detailed Help Example:
admin:help file list 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
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
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
where command represents the command name or the command and parameter.
admin:file list activelog?Syntax: file list activelog file-spec [options] file-spec mandatory file to view options optional page|detail|reverse|[date|size]
If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.
Exit Command with Ctrl-C Key Sequence
You can stop most interactive commands by entering the Ctrl-C key sequence.
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
To end the CLI session, enter quit at the CLI prompt.
If you are logged in remotely, you get logged off, and the SSH session is terminated. If you are logged in locally, you get logged off, and the login prompt appears.