Cisco Quick Set C20, Reference Manual

Page: 10 / 195

D14869.11
Codec C20 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 10
Cisco TelePresence System Codec C20 API Reference Guide
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.
?
- User Commands -
help
xstatus
bye
xconfiguration
xevent
log
xfeedback
xpreferences
echo xgetxml
xcommand xhistory
systemtools
OK
API commands
xConfiguration
Configurations are system settings, such as system name
and network settings. These are persistent across boots.
Refer to

"Configurations" on page 13 .
xCommand
Commands instruct the codec to execute actions, such as to
dial a number or to search the phone book.
Refer to

"Commands" on page 12 .
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.
Refer to

"Status" on page 14 .
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. Refer to

"Feedback mechanism" on page
17 .
xPreferences
The xPreferences command is used to set preferences for
the RS-232, Telnet and SSH sessions.
Refer to

"API output" on page 9 .
Echo <on/off>
If echo is set to On the key inputs are displayed when
entering text in a command line interface.
If echo is set to Off no user input is displayed when entering
text in a command line interface.
xEvent
the xEvent command returns information on which events are
available for feedback. Refer to

"Events" on page 15 .
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. Refer to

"Feedback mechanism" on page 17 .
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.
Refer to

"The SystemTools commands" on page 192 .
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.
Contents Introduction About the API xConfiguration Appendices xCommand xStatus About the API