Table Of Contents - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Contents Contents Introduction
What's in this guide?
The top menu bar and the entries in the table of
TA - ToC - Hidden
text anchor
contents are all hyperlinks, just click on them to
go to the topic.
We recommend you visit our web site regularly
for updated versions of the user documentation.
Go to:http://www.cisco.com/go/quickset-docs
SX20 Codec API Reference Guide TC6.2, JULY 2013.
D14949.04
About the API xConfiguration

Table of Contents

Introduction ..........................................................................3
About this guide ......................................................................4
User documentation .............................................................4
What's new in this version ......................................................5
Software release notes ........................................................5
Software download ..............................................................5
New features and improvements .........................................5
xConfiguration changes .......................................................6
xCommand changes ............................................................ 7
xStatus changes ................................................................... 7
About the API ........................................................................8
API fundamentals ....................................................................9
Connecting to the API ..........................................................9
Password .............................................................................9
RS-232/serial connection ....................................................9
Telnet ....................................................................................9
SSH ......................................................................................9
HTTP/HTTPS ........................................................................9
API output .............................................................................10
The output modes ..............................................................10
Using the command line ....................................................... 11
API commands ................................................................... 11
Other commands ............................................................... 11
Command line shortcuts .................................................... 11
Searching ........................................................................... 12
Value types and formats .................................................... 12
Commands ........................................................................... 13
Configurations ...................................................................... 14
Status .................................................................................... 15
Events ...................................................................................16
Call history ............................................................................ 17
2
xCommand xStatus
Feedback mechanism...........................................................18
Feedback expressions .......................................................18
Terminal connections ......................................................... 19
Using HTTP ...........................................................................20
Getting status and configurations ......................................20
Sending commands and configurations.............................20
Using HTTP POST ..............................................................20
Feedback from codec over HTTP ........................................ 21
Registering for feedback .................................................... 21
Translating from terminal mode to XML..............................22
Dos and don'ts ......................................................................23
xConfiguration commands .................................................. 24
Description of the xConfiguration commands ......................25
xCommand commands ....................................................... 74
Description of the xCommand commands ...........................75
xStatus commands ........................................................... 113
Description of the xStatus commands ............................... 114
Appendices....................................................................... 178
Startup script ...................................................................... 179
Adding a startup script ..................................................... 179
Cisco TelePresence Remote Control ..................................180
Remote control key map ..................................................... 181
The SystemTools commands .............................................. 182
About disconnect cause types ...........................................184
Copyright © 2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices