Using The Command Line; Api Commands; Other Commands - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

Using the command line

Help
To get a list of all supported top level commands you can
type ? or help after connecting to the TelePresence System
using RS-232, Telnet or SSH (Example 1).
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.
Refer to "Configurations" on page 28.
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 28.
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 28.
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
SX20 Codec API Reference Guide CE8.1, APRIL 2016.
D15316.03
About the API About the API xConfiguration
Example 1:
?
help
xgetxml
bye
OK
xPreferences
The xPreferences command is used to set preferences for
the RS-232, Telnet and SSH sessions.
Refer to "API output" on page
Echo <on/off>
If echo is set to
ing text in a command line interface.
If echo is set to
text in a command line interface.
xEvent
The xEvent command returns information on which events are
available for feedback. Refer to
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
30.
xCommand
- User Commands -
xcommand xconfiguration
xdocument xpreferences
echo log
25.
On the key inputs are displayed when enter-
Off user input is not displayed when entering
"Events" on page 29.
"Feedback mechanism" on page 30.
26
xStatus
xevent xfeedback
xtransaction xstatus
systemtools

Other commands

Systemtools
The systemtools commands are a set of command line tools
for administrative control and diagnostics. The commands
can be used for advanced troubleshooting together with
Cisco technical support. Systemtools are not a part of the
programming API. Refer to "The SystemTools commands"
on page 176.
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
Copyright © 2016 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices