Cisco TelePresence SX20 User manual

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.1
Cisco TelePresence SX20 Codec API Reference Guide
Software version CE9.1
JUNE 2017
Application Programming Interface (API)
Reference Guide
Cisco TelePresence SX20 Codec
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus


D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.2
Cisco TelePresence SX20 Codec API Reference Guide
TA - ToC - Hidden
text anchor
Table of Contents
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
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
SSH .................................................................................... 15
Telnet .................................................................................. 15
HTTP/HTTPS ...................................................................... 15
RS-232 / serial connection ................................................ 16
User roles ........................................................................... 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
Using HTTP...........................................................................24
HTTP XMLAPI Authentication.............................................24
HTTP XMLAPI Session Authentication............................... 24
Getting status and configurations ......................................25
Sending commands and configurations.............................25
Using HTTP POST ..............................................................25
Feedback from codec over HTTP.........................................26
Registering for feedback ....................................................26
Translating from terminal mode to XML .............................27
Dos and don’ts......................................................................28
xConfiguration commands.................................................. 29
Description of the xConfiguration commands ......................30
xCommand commands....................................................... 88
Description of the xCommand commands ...........................89
xStatus commands ........................................................... 133
Description of the xStatus commands................................134
Appendices....................................................................... 189
About startup scripts ..........................................................190
The SystemTools commands.............................................. 191
About disconnect cause types...........................................193
User documentation on the Cisco web site........................194
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus


D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.3
Cisco TelePresence SX20 Codec API Reference Guide
Chapter 1
Introduction
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.4
Cisco TelePresence SX20 Codec API Reference Guide
About this guide
This guide introduces you to the Application Programmer
Interface (API) for the CE software in general, and serve as
a reference guide for the command line commands for the
following product:
• Cisco TelePresence SX20 Codec
The guide describes the API for on-premise registered video
systems (CUCM, VCS) as well as video systems registered
to Cisco’s cloud service (Cisco Spark). For Cisco Spark
registered systems only a subset of the API is available, and
the user role (integrator and roomcontrol) of the local user
determines which commands are available.
Downloading the user documentation
You can download the user documentation from the Cisco
web site, go to: http://www.cisco.com/go/sx-docs
For Spark registred systems, go to:
https://support.ciscospark.com
Guidelines for how to find the documentation on the Cisco
web site are included in the User documentation on the
Cisco web site appendix.
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.5
Cisco TelePresence SX20 Codec API Reference Guide
New features and improvements
New wake-up experience
The new wake-up experience introduces a Halfwake state,
which leads to a calmer wake-up of the system, and gives
users better guidance on how to get started.
When wake-up on motion detection is enabled the system
will automatically wake to the Halfwake state when people
enter the room. It will also wake to this state when a user
pairs a Cisco Proximity client to the system.
Additions for Room Analytics
Detect people presence in the room: The video system has
the capability to find whether there are people present in the
room. The feature is based on ultrasound, and it does not
keep record of who was in the room, only whether or not the
room is in use.
What’s new in CE9.1
This section provides an overview of the new and
changed system settings, and the new features and
improvements in the Cisco Collaboration Endpoint
software version 9.1 (CE9.1) compared to CE9.0.
For more details, we recommend reading the Software
release notes:
http://www.cisco.com/c/en/us/support/collabo-
ration-endpoints/telepresence-quick-set-series/
products-release-notes-list.html
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.6
Cisco TelePresence SX20 Codec API Reference Guide
System configuration changes in CE9.1
New configurations
RoomAnalytics PeoplePresenceDetector
Configurations that are removed
None.
Configurations that are modified
Conference DefaultCal Rate
OLD: Default value: 3072
NEW: Default value: 6000
Network[ 1] IEEE8021X Password
OLD: Valuespace: String(0, 32)
NEW: Valuespace: String(0, 50)
Video Input Connector [n] PresentationSelection
OLD: Valuespace: AutoShare/Manual/OnConnect
NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.7
Cisco TelePresence SX20 Codec API Reference Guide
System command changes in CE9.1
New commands
SystemUnit FirstTimeWizard Stop
UserInterface Extensions Set
Commands that are removed
None.
Commands that are modified
SystemUnit FactoryReset (All products)
OLD: Keep: LocalSetup/Network/Spark/Provisioning
NEW: Keep: LocalSetup/Network/Spark/Provisioning/SerialPort/Certificates (not in use)
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.8
Cisco TelePresence SX20 Codec API Reference Guide
System status changes in CE9.1
New statuses
RoomAnalytics PeoplePresence
SystemUnit Software OptionKeys Encryption
Statuses that are removed
None
Statuses that are modified
Diagnostics Message Type
OLD: Value space: CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile
/ CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility /
CallProtocolVcsProvisioningCompatibility / CameraId / CameraPairing / CameraSerial
/ CameraSoftwareVersion / CameraStatus / CamerasDetected / ConfigurationFile /
DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus / PresenterTrack /
H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey / IpCameraStatus /
IPv4Assignment / IPv6Assignment / IPv6Mtu / ISDNLinkCompatibility / ISDNLinkIpStack
/ ITLinstallation / InvalidSIPTransportConfig / LockDown / RoomControl /
MediaBlockingDetected / NetLinkStatus / NetSpeedAutoNegotiated / NetworkQuality /
NTPStatus / OSDVideoOutput / OutputConnectorLocations / ProvisioningDeveloperOptions
/ ProvisioningStatus / SIPEncryption / SIPListenPortAndOutboundMode /
SIPProfileRegistration / SIPProfileType / SelectedVideoInputSourceConnected
/ SipIceAndAnatConflict / SIPListenPortAndRegistration / TCPMediaFallback
/ TemperatureCheck / TLSVerifyRequiredCerts / TouchPanelConnection
/ ControlSystemConnection / TurnBandwidth / UdpPortRangeViolation /
UltrasoundSpeakerAvailability / ValidPasswords / VideoFromInternalCamera
/ VideoInputStability / VideoInputSignalQuality / SparkConnectivity /
SpeakerTrackFrontPanelMountedCorrectly / SpeakerTrackMicrophoneConnection
/ SpeakerTrackVideoInputs / SpeakerTrackEthernetConnection / ANATOnVCS /
ECReferenceDelay / AudioECRefDelay / AudioPairingNoise / AudioPairingRate
/ AudioPairingSNR / AudioPairingInterference / AudioPairingTokenDecode /
AudioInternalSpeakerDisabled / AbnormalCallTermination / HasActiveCallProtocol /
SipOrH323ButNotBothEnabled / PresentationSourceSelection / SoftwareUpgrade
/ PlatformSanity / ContactInfoMismatch / MicrophoneReinforcement /
FirstTimeWizardNotCompleted / CaptivePortalDetected / MonitorDelay
NEW: Value space: :CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile
/ CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility /
CallProtocolVcsProvisioningCompatibility / CameraId / CameraPairing / CameraSerial /
CameraSoftwareVersion / CameraStatus / CamerasDetected / CamerasDetectedNoIr
/ ConfigurationFile / DefaultCallProtocolRegistered / EthernetDuplexMatches /
FanStatus / PresenterTrack / H320GatewayStatus / H323GatekeeperStatus /
HasValidReleaseKey / IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu
/ ISDNLinkCompatibility / ISDNLinkIpStack / ITLinstallation / InvalidSIPTransportConfig
/ LockDown / RoomControl / MediaBlockingDetected / NetLinkStatus /
NetSpeedAutoNegotiated / NetworkQuality / NTPStatus / OSDVideoOutput /
OutputConnectorLocations / ProvisioningDeveloperOptions / ProvisioningStatus
/ SIPEncryption / SIPListenPortAndOutboundMode / SIPProfileRegistration /
SIPProfileType / SelectedVideoInputSourceConnected / SipIceAndAnatConflict
/ SIPListenPortAndRegistration / TCPMediaFallback / TemperatureCheck /
TLSVerifyRequiredCerts / TouchPanelConnection / ControlSystemConnection
/ TurnBandwidth / UdpPortRangeViolation / UltrasoundSpeakerAvailability
/ ValidPasswords / VideoFromInternalCamera / VideoInputStability /
VideoInputSignalQuality / SparkConnectivity / SpeakerTrackFrontPanelMountedCorrectly
/ SpeakerTrackMicrophoneConnection / SpeakerTrackVideoInputs /
SpeakerTrackEthernetConnection / ANATOnVCS / ECReferenceDelay / AudioECRefDelay
/ AudioPairingNoise / AudioPairingRate / AudioPairingSNR / AudioPairingInterference /
AudioPairingTokenDecode / AudioInternalSpeakerDisabled / AbnormalCallTermination /
HasActiveCallProtocol / SipOrH323ButNotBothEnabled / PresentationSourceSelection /
SoftwareUpgrade / PlatformSanity / ContactInfoMismatch / MicrophoneReinforcement /
FirstTimeWizardNotCompleted / CaptivePortalDetected / MonitorDelay / WifiCARequired
Standby State
OLD: Value space: Standby/EnteringStandby/Off
NEW: Value space: Standby/EnteringStandby/Halfwake/Off
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.9
Cisco TelePresence SX20 Codec API Reference Guide
New features and improvements
Updated user interface
The user interfaces on the Touch 10, on screen, and on
the integrated touch screen have been updated. The main
menu items on the home screen have been replaced with
more prominent activities.
Some of the setting have been removed from the Touch
10 advanced settings menu to align with the on-screen
display menu.
Wakeup on motion detection
Wakeup on motion detection senses when a person
walks into the conference room and the system wakes up
automatically. You need to enable the following setting for
this feature to work:
xConfiguration Standby WakeupOnMotionDetection
You can’t manually place the system in standby when this
feature is enabled.
Updated In-Room Control Editor
The In-Room Control editor is updated with a new look,
improved logic and usability for producing a control inter-
face more efficiently. In addition, a new directional pad
widget and an In-Room Control simulator is added.
Added language support
We have added support for Potuguese (Portugal) to the
on-screen display and Touch controller menus.
Other changes
• Support for HTTPS client certificates has been added.
• Unplugging the presentation cable instantly stops the
presentation sharing.
What’s new in CE9.0
This section provides an overview of the new and
changed system settings, and the new features and
improvements in the Cisco Collaboration Endpoint
software version 9.0 (CE9.0) compared to CE8.3.
For more details, we recommend reading the Software
release notes:
http://www.cisco.com/c/en/us/support/collaboration-
endpoints/telepresence-quick-set-series/
products-release-notes-list.html
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction

D15316.07 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.10
Cisco TelePresence SX20 Codec API Reference Guide
System configuration changes in CE9.0
New configurations
NetworkServices HTTPS Server MinimumTLSVersion
NetworkServices HTTPS StrictTransportSecurity
NetworkServices UPnP Mode
Configurations that are removed
Audio Microphones PhantomVoltage
Configurations that are modified
Cameras Camera [n] *
OLD: User role: ADMIN, USER
NEW: User role: ADMIN, INTEGRATOR
Conference MultiStream Mode
OLD: Value space: Auto/Off
NEW: Value space: Off
UserInterface Language
NEW: Portuguese added to value space
xConfigurations with INTERATOR user role
A new user role - INTEGRATOR - is introduced in CE9.0. It has been added to the following
configurations:
Audio DefaultVolume
Audio Input Line [n] *
Audio Input Microphone [n] *
Audio Microphones Mute Enabled
Audio Output Line [n] *
Audio SoundsAndAlerts *
Cameras Camera [n] *
Conference DefaultCall Rate
Conference DoNotDisturb DefaultTimeout
Peripherals Profile *
SerialPort BaudRate
SerialPort Mode
Standby *
SystemUnit Name
Time Zone
UserInterface OSD Output
Video Input Connector [n] CameraControl CameraId
Video Input Connector [n] CameraControl Mode
Video Input Connector [n] InputSourceType
Video Input Connector [n] Name
Video Input Connector [n] PresentationSelection
Video Input Connector [n] Quality
Video Input Connector [n] Visibility
Video Monitors
Video Output Connector [n] CEC Mode
Video Output Connector [n] MonitorRole
Video Output Connector [n] Resolution
Video Presentation DefaultPIPPosition
Video Selfview Default *
Video Selfview OnCall *
<path> * means that the change applies to all configurations starting with <path>.
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus

Introduction