Cisco Unified Presence, Release 7.x -- How to Work with the CLI
Main page: Cisco Unified Presence, Release 7.x
Starting a CLI Session
You can access the Cisco IPT Platform CLI remotely or locally:
- From a web client workstation, such as the workstation that you use for Cisco IPT Platform Administration, you can use SSH to connect securely to the Cisco IPT Platform.
- You can access the Cisco IPT Platform 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
- An administrator ID
- A password
You will need this information to log in to the Cisco IPT Platform.
1. Perform 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 the administrator ID that was defined during installation.
2. Enter the password that was defined at installation.
- The CLI prompt displays. The prompt represents the Administrator ID; for example:
- You can now use any CLI command.
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 is completed.
- Enter a full command name and press Tab to display all the commands or subcommands that are available. For example, if you enter set and press Tab, you see all the set subcommands. An * identifies the commands that have subcommands.
- If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.
Getting Help about Commands
You can get two kinds of help about 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
If you want to: At the CLI prompt:
Get detailed help
- help command
- Where command specifies the command name or the command and parameter. See Example: Detailed Help Example:.
Query only command syntax
- Where command represents the command name or the command and parameter. See Example: Query Example:.
If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available.
Example: Detailed Help Example:
admin:help file list activelog
This will list active logging files
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
Example: Query Example:
admin:file list activelog?
file list activelog file-spec [options]
file-spec mandatory file to view
options optional page|detail|reverse|[date|size]
Ending a CLI Session
At the CLI prompt, enter quit. If you are logged in remotely, you get logged off, and the ssh session is dropped. If you are logged in locally, you get logged off, and the login prompt returns.