cisco telepresence system codec c20 api reference guide anchor table of contents introduction ......

Download Cisco TelePresence System Codec C20 API Reference Guide anchor Table of Contents Introduction ... Adding

Post on 23-Feb-2020

0 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • 1

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Software version TC5.0 NOVEMBER 2011

    Application Programmer Interface (API) Reference Guide

    Cisco TelePresence System Codec C20

  • 2

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    TA - ToC - Hidden text anchor

    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

    What’s in this guide?

    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 ...................... 63

    Description of the xStatus commands

    Description of the xStatus commands .............................. 91

    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

    http://www.cisco.com/go/telepresence/docs http://www.cisco.com/go/telepresence/docs

  • 3

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Appendices

    Startup script ................................................................... 140 Adding a startup script ................................................ 140

    Cisco TelePresence Remote Control ...............................141

    Remote control key map ..................................................142

    Overview of the xConfiguration commands.................... 143

    Overview of the xCommand commands ........................ 146

    Overview of the xStatus commands ............................... 148

  • 4

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Chapter 1

    Introduction

  • 5

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    About this guide This guide will introduce you to the Application Programmer Interface (API) for the TC software in general, and serve as a reference guide for the command line commands for the Codec C Series listed below: • Cisco TelePresence System Codec C20

    User documentation The user documentation for the Cisco TelePresence systems, running the TC software, have several guides suitable to various user groups. • Video conference room primer • Video conference room acoustics guidelines • Installation guides for the TelePresence systems • Software release notes for the TC software • Getting started guide for the TelePresence systems • User guide for the TelePresence systems (Touch controller) • User guide for the TelePresence systems (Remote Control) • Quick reference guides for the TelePresence systems • Administrator guides for the TelePresence systems • Camera user guide for the PrecisionHD cameras • API reference guides for the Codec C Series • TC Console user guide for the Codec C Series • Physical interfaces guides for the Codec C Series • Regulatory compliance and safety information guides • Legal & license information for the TC software

    Download the user documentation Go to: http://www.cisco.com/go/telepresence/docs - in the right pane, select: • TelePresence Solutions Platform for the Codec C Series

    and Quick Set C20. • TelePresence Peripherals for the PrecisionHD cameras,

    microphones, Touch unit, and remote controls.

    http://www.cisco.com/go/telepresence/docs

  • 6

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.02 Codec C20 API Reference Guide TC5.0 November 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    What’s new in this version This section provides an overview of the new and changed advanced settings and new features in the TC5.0 software version.

    Software release notes For a complete overview of the news and changes, we recommend reading the Software Release Notes (TC5). Go to: http://www.cisco.com/en/US/products/ps11422/ tsd_products_support_series_home.html

    Software download For software download go to: http://www.cisco.com/cisco/ software/navigator.html

    New features and improvements

    Support for native CUCM registration

    With TC5 the video systems are able to register to the Cisco Unified Communications Manager (CUCM) version 8.6 as a native Cisco device. Supported features are: • Basic telephony features like call, hold/resume, transfer • CUCM provisioning • CUCM phonebook • Software upgrade Encrypted calls are not supported.

    Support for Cisco TelePresence Multipoint Switch (CTMS)

    In TC5 interoperability with CTMS version 1.8 is achieved. The following features are supported: • Multipoint conferences hosted

Recommended

View more >