Using The Command Line - Cisco TelePresence SX80 Reference Manual

Cisco TelePresence SX80
Contents 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.
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 16.
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 15.
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 17.
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
Codec SX80 API Reference Guide TC7.3, OCTOBER 2015.
D15107.05
About the API About the API xConfiguration
?
- User Commands -
help xcommand
xgetxml xdocument
echo log
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 On the key inputs are displayed when enter-
ing 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
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
19.
xCommand
xconfiguration xevent
xpreferences xstatus
systemtools
Other commands
Systemtools
12.
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
on page
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
"Events" on page 18.
Command line shortcuts
If your client supports it, there are some timesaving shortcuts
you can use:
•
19. •
•
•
•
•
13
API Reference Guide
xStatus
xfeedback
bye
"The SystemTools commands"
228.
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 © 2015 Cisco Systems, Inc. All rights reserved.
Appendices