Using The Command Line - Cisco Codec C20 Reference Manual

Cisco TelePresence System Codec C20
Contents Introduction

Using the command line

Help
To get a list of all supported root commands you can type
or help after connecting to the TelePresence System using
RS-232, Telnet or SSH.
Bye
Typing the bye command closes the command line interface.
API commands
xConfiguration
Configurations are system settings, such as system name and
network settings. These are persistent across boots. For more
information see "Configurations".
xCommand
Commands instruct the codec to execute actions, such as to
dial a number or to search the phone book. For more informa-
tion see "Commands".
xStatus
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources. For more information
see "Status".
xFeedback
The Feedback commands are used to specify what parts of
the configuration and status hierarchies to monitor. Feedback
is only issued on the RS-232, Telnet or SSH session for which
it is specified. If you are connecting to the codec with multiple
sessions, you have to define feedback individually for each
session. For more information see
"Feedback
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API About the API
?
- User Commands -
help
?
xstatus
bye
OK
xPreferences
The xPreferences command is used to set preferences for the
RS-232, Telnet and SSH sessions. For more information see
output".
"API
echo <on/off>
If echo is set to On
text in a command line interface.
If echo is set to Off
text in a command line interface.
xevent
the xEvent command returns information on which events are
available for feedback. For more information see "Events".
xHistory
The xHistory command returns the call log.
xGetxml
The xGetxml request returns an XML document based on the
location parameter attached to the request. The elements (or a
complete document) matching the expression will be returned.
For more information see
mechanism".
xConfiguration xCommand
xconfiguration xfeedback
xevent xpreferences
log echo
the key inputs are displayed when entering
no user input is displayed when entering
HTTP".
"Using
12
API Reference Guide
xStatus
xgetxml
xcommand
Other commands
Systemtools
The systemtools commands are used for administrative control
of the codec and are only available from the command line
interface. Systemtools are not a part of the programming API.
For more information see "The SystemTools commands"
the Appendices chapter.
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
Command line shortcuts
If your client supports it, there are some timesaving shortcuts
you can use:
Tab-completion to complete the commands and arguments.
•
• Arrow up and arrow down keys to navigate your command
history.
• <CTRL-a>: Jump to the beginning of the line.
• <CTRL-e>: Jump to the end of the line.
• <CTRL-r>: Incremental command history search.
• <CTRL-w>: Erase the current line.
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
Appendices
xhistory
systemtools
in