Using The Command Line Interface (Cli); Command Types - Cisco TelePresence Video Communication Server Administrator's Manual

Using the command line interface (CLI)

The VCS can be configured through a web interface or via a command line interface (CLI).
The CLI is available by default over SSH and through the serial port. Access using Telnet can also be
enabled. These settings are controlled on the
To use the CLI:
1. Start an SSH or Telnet session.
2. Enter the IP address or FQDN of the VCS.
3. Log in with a username of admin and your system password.
4. You can now start using the CLI by typing the appropriate commands.

Command types

Commands are divided into the following groups:
xStatus: these commands return information about the current status of the system. Information
n
such as current calls and registrations is available through this command group. See
reference — xStatus
xConfiguration: these commands allow you to add and edit single items of data such as IP
n
address and zones. See
commands.
xCommand: these commands allow you to add and configure items and obtain information. See
n
Command reference — xCommand
xHistory: these commands provide historical information about calls and registrations.
n
xFeedback: these commands provide information about events as they happen, such as calls and
n
registrations.
Note that:
Typing an xConfiguration path into the CLI returns a list of values currently configured for that
n
element (and sub-elements where applicable).
Typing an xConfiguration path into the CLI followed by a ? returns information about the usage
n
for that element and sub-elements.
Typing an xCommand command into the CLI with or without a ? returns information about the usage
n
of that command.
Cisco VCS Administrator Guide (X6.1)
About the Cisco TelePresence Video Communication Server (VCS)
System administration
for a full list of xStatus commands.
Command reference — xConfiguration
for a full list of xCommand commands.
page.
Command
for a full list of xConfiguration
Page 21 of 401