Using Cisco TelePresence Manager CLI Commands
First Published: October 31, 2011, OL-23878-01
This chapter explains how to use Cisco TelePresence System Manager (CTS-Manager) command-line interface (CLI) commands. This chapter contains the following information:
•Starting a CLI Session
Starting a CLI Session
The SysAdmin can access the CTS-Manager CLI remotely or locally:
•From a web client workstation, such as the workstation that you use for CTS-Manager administration, you can use SSH to connect securely to CTS-Manager.
•Using the monitor and keyboard that you used during installation, you can access the CTS-Manager 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.
Before You Begin
Ensure you have the following information that gets defined during installation:
•A primary IP address and hostname
•The SysAdmin ID
•The SysAdmin password
Note SysAdmin ID and password are the Administrator ID and password that are created during installation of CTS-Manager.
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
where sysadminname specifies the Administrator ID created during installation 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:
where ipt-1 represents the host name of the system.
Enter the SysAdmin ID.
In either case, the system prompts you for a password.
Step 2 Enter your password.
The CLI prompt displays. The prompt represents the SysAdmin ID; for example:
The following section contains basic tips for using the command line interface.
•Getting Help on Commands
•Ending a CLI Session
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 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 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
Where command specifies the command name or the command and parameter. See Example 1-1.
Note 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. See Example 1-2.
Note 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 1-1 Detailed Help Example:
admin:help file list activelog
This will list active logging files
detail - show detailed listing
reverse - reverse sort order
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 1-2 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 gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.
The following chapters list and describe the CLI commands that are available for the CTS-MAN system.