Table Of Contents - Cisco TelePresence System Codec C90 Reference Manual

Cisco TelePresence System Codec C90
Contents Contents Introduction
What's in
TA - ToC -
Hidden text
anchor
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/telepresence/
docs
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved.
About the API xConfiguration

Table of Contents

Introduction
About this guide .................................................................. 5
User documentation ........................................................ 5
What's new in this version .................................................. 6
Software release notes ................................................... 6
Software download ......................................................... 6
New features and improvements .................................... 6
xConfiguration changes .................................................. 7
xCommand changes ....................................................... 7
xStatus changes .............................................................. 7
About the API
About the API ...................................................................... 9
Basic Principles ............................................................... 9
The API-Engine ............................................................... 9
Structuring of Information ................................................ 9
Addressing Using XPath or SimplePath ........................ 10
Feedback ....................................................................... 10
Connecting to the codec ...................................................11
Accessing XACLI ............................................................11
Telnet/SSH login .........................................................11
Serial port login...........................................................11
Serial port configurations ...........................................11
Reboot ........................................................................11
Hardware & Cabling (RS-232) ........................................11
Troubleshooting (RS-232) ..............................................11
Value types and formats ....................................................12
User commands .................................................................13
Main type of commands .....................................................14
Configuration type commands .......................................14
Command type commands ............................................14
Status type commands ..................................................14
Special commands .........................................................14
Feedback type command ...........................................14
Preferences type command .......................................14
2
xCommand xStatus
About xConfiguration ........................................................ 15
xConfiguration operations ................................................. 16
Return result parameters ............................................... 16
xConfiguration Help ....................................................... 16
xConfiguration Read ...................................................... 16
xConfiguration Write ...................................................... 16
About xCommand ..............................................................17
xCommand operations ...................................................... 18
Return result parameters ............................................... 18
xCommand Help ............................................................ 18
xCommand Write ........................................................... 18
About xStatus commands ................................................. 19
Quering status information ............................................ 20
About xHistory ................................................................... 21
About xEvent ..................................................................... 22
About xFeedback .............................................................. 23
About xPreferences .......................................................... 24
The xPreferences output modes ................................... 24
The SystemTools commands ............................................ 25
XML API service ................................................................ 27
Description of the xConfiguration commands
Description of the xConfiguration commands .................. 29
Description of the xCommand commands
Description of the xCommands commands ...................... 71
Description of the xStatus commands
Description of the xStatus commands .............................113
API Reference Guide
Appendices
www.cisco.com