Table Of Contents - Cisco MX700 Reference Manual

Cisco TelePresence MX700 and MX800
 
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/mx-docs
D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.
About the API xConfiguration

Table of Contents

Introduction ........................................................................... 3
About this guide ...................................................................... 4
Downloading the user documentation ................................. 4
What's new in CE9.2 ............................................................... 5
What's new in CE9.1 ............................................................. 12
What's new in CE9.0 ............................................................. 16
About the API ...................................................................... 21
API fundamentals ..................................................................22
Connecting to the API ........................................................22
Password ............................................................................22
SSH ....................................................................................22
Telnet ..................................................................................22
HTTP/HTTPS ......................................................................22
RS-232 / serial connection ................................................23
User roles ...........................................................................23
API output ............................................................................. 24
The output modes .............................................................. 24
Using the command line .......................................................25
API commands ...................................................................25
Other commands................................................................25
Command line shortcuts ....................................................26
Searching ...........................................................................26
Value types and formats.....................................................26
Commands ............................................................................ 27
Configurations ....................................................................... 27
Status .................................................................................... 27
Multiline commands ..............................................................28
Synchronous API calls ..........................................................29
Events ...................................................................................30
xCommand
Feedback mechanism ........................................................... 31
Feedback from codec over HTTP .........................................35
Dos and don'ts ...................................................................... 37
xConfiguration commands .................................................. 38
Description of the xConfiguration commands ......................39
xCommand commands ..................................................... 108
Description of the xCommand commands .........................109
xStatus commands ........................................................... 172
Description of the xStatus commands ................................ 173
Appendices ....................................................................... 235
About startup scripts ..........................................................236
The SystemTools commands ..............................................237
About disconnect cause types ...........................................239
User documentation on the Cisco web site ........................240
2
API Reference Guide
xStatus Appendices
Feedback expressions ....................................................... 31
Terminal connections .........................................................32
HTTP XMLAPI Authentication .............................................33
HTTP XMLAPI Session Authentication ...............................33
Getting status and configurations ......................................34
Sending commands and configurations .............................34
Registering for feedback ....................................................35
Translating from terminal mode to XML .............................36
Copyright © 2017 Cisco Systems, Inc. All rights reserved.