Table Of Contents - Cisco TelePresence SX10 Reference Manual

Cisco TelePresence SX10
 
Introduction
What's in this guide?
The top menu bar and the entries in the table of 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/sx-docs
Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017.
D15333.07
About the API xConfiguration

Table of Contents

Introduction ........................................................................... 3
About this guide ...................................................................... 4
Downloading the user documentation ................................. 4
What's new in CE9.1 ............................................................... 5
What's new in CE9.0 ............................................................... 9
About the API ...................................................................... 14
API fundamentals .................................................................. 15
Connecting to the API ........................................................ 15
Password ............................................................................ 15
Telnet .................................................................................. 15
SSH .................................................................................... 15
HTTP/HTTPS ...................................................................... 15
Serial connection over micro USB ..................................... 16
API output ............................................................................. 17
The output modes .............................................................. 17
Using the command line ....................................................... 18
API commands ................................................................... 18
Other commands................................................................ 18
Command line shortcuts .................................................... 19
Searching ........................................................................... 19
Value types and formats..................................................... 19
Commands ............................................................................20
Configurations .......................................................................20
Status ....................................................................................20
Events ................................................................................... 21
Feedback mechanism ...........................................................22
Feedback expressions .......................................................22
Terminal connections .........................................................23
xCommand
Using HTTP ........................................................................... 24
Feedback from codec over HTTP .........................................26
Dos and don'ts ......................................................................28
xConfiguration commands .................................................. 29
Description of the xConfiguration commands ......................30
xCommand commands ....................................................... 83
Description of the xCommand commands ...........................84
xStatus commands ........................................................... 127
Description of the xStatus commands ................................ 128
Appendices ....................................................................... 182
About startup scripts ..........................................................183
The SystemTools commands ..............................................184
About disconnect cause types ...........................................186
User documentation on the Cisco web site ........................ 187
2
API Reference Guide
xStatus Appendices
HTTP XMLAPI Authentication ............................................. 24
HTTP XMLAPI Session Authentication ............................... 24
Getting status and configurations ......................................25
Sending commands and configurations .............................25
Using HTTP POST ..............................................................25
Registering for feedback ....................................................26
Translating from terminal mode to XML ............................. 27
Copyright © 2017 Cisco Systems, Inc. All rights reserved.