Page 1 About the API xConfiguration xCommand xStatus Appendices Collaboration Endpoint Software 8.2 SEPTEMBER 2016 Application Programming Interface (API) Reference Guide Cisco TelePresence SX10 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 2: Table Of Contents
Other commands ...............32 Command line shortcuts ............33 User documentation on the Cisco web site .......183 Searching ................33 Value types and formats ............33 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 3: Introduction
Cisco TelePresence SX10 API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 4: We Recommend You Visit Our Web Site Regularly For Updated About This Guide
Cisco web site appendix. NOTE: This guide doesn’t apply to Cisco TelePresence SX10 Quick Sets that are registered to Cisco Spark. To find more information on Cisco Spark room systems, visit: https://www.help.webex.com Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016.
Page 5: Go To:Http://Www.cisco.com/Go/Sx-Docs What's New In Ce8.2
Touch 10 controller to a video System is managed by Cisco and if there are any issues, wise upgrading to CE8 can leave you with a system. All user credentials can be used for this purpose.
Page 6 A visual update has been applied to the Setup and Pairing Wizard on the Touch 10. The Touch 10 has a new GUI when registered to Cisco Spark, which is similar to the Cisco TelePresence SX10 on-screen user interface. If the endpoint is registered to on-premise infrastructure, the Touch 10 controller has the same user interface as CE8.1.
Page 7: Xconfiguration Changes In Ce8.2
UserManagement LDAP Attribute NEW: User Role: ADMIN, USER UserManagement LDAP BaseDN Provisioning LoginName OLD: User Role: ADMIN NEW: User Role: ADMIN, USER Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 8 PC / camera / desktop / document_camera / mediaplayer / other / whiteboard Video Input Connector [n] PresentationSelection OLD: AutoShare / Manual / OnConnect NEW: AutoShare / Desktop / Manual / OnConnect Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 9: Xcommand Changes In Ce8.2
OLD: Type: <Encryption / PremiumResolution / RemoteMonitoring> NEW: Type: <Encryption / RemoteMonitoring> Time DateTime Set OLD: Role: <Admin> NEW: Role: <User;Admin> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 10: Xstatus Changes In Ce8.2
SipOrH323ButNotBothEnabled / PresentationSourceSelection / SoftwareUpgrade / PlatformSanity / ContactInfoMismatch / ProximityContentShareToClientsWithMultistream> NEW: <CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile / CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility / Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 11: What's New In Ce8.1
The Room  http://www.cisco.com/c/en/us/support/collab- system’s web interface. You can also work offline with a System is managed by Cisco and if there are any issues, oration-endpoints/telepresence-quick-set-series/ stand-alone version of the editor. The editor is available contact Cisco Technical Assistance center through the products-release-notes-list.html...
Page 12 “Share” to share the presentation with the far-end. For further details, refer to xConfiguration Video Input Connector [n] PresentationSelection. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 13: Xconfiguration Changes In Ce8.1
Phonebook Server [1] Type OLD: <CUCM / Off / TMS / VCS> NEW: <CUCM / Off / Spark /TMS / VCS> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 14: Xcommand Changes In Ce8.2
Layout/ Left/ Mute/ MuteMic/ Ok/ PhoneBook/ Presentation/ Right/ Selfview/ Square/ SrcAux/ OLD: Zoom: <0-65535> SrcCamera/SrcDocCam/ SrcPc/ SrcVcr/ Star/ Up/ VolumeDown/ VolumeUp/ ZoomIn/ ZoomOut/ +/ -> NEW: Zoom: <0-8000> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 15 Layout/ Left/ Mute/ MuteMic/ Ok/ PhoneBook/ Presentation/ Right/ Selfview/ Square/ SrcAux/ SrcCamera/SrcDocCam/ SrcPc/ SrcVcr/ Star/ Up/ VolumeDown/ VolumeUp/ ZoomIn/ ZoomOut/ +/ -> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 16: Xstatus Changes In Ce8.2
<Dual/ DualPresentationOnly/ Quadruple/ Single/ Triple/ TriplePresentationOnly> H320GatewayStatus/ H323GatekeeperStatus/HasValidReleaseKey/IpCameraStatus/ IPv4Assignment/IPv6Assignment/IPv6Mtu/ISDNLinkCompatibility/ISDNLinkIpStack/ ITLinstallation/InvalidSIPTransportConfig/LockDown/NetLinkStatus/ NetSpeedAutoNegotiated/NTPStatus/OSDVideoOutput/OutputConnectorLocations/ ProvisioningStatus/SIPEncryption/SIPListenPortAndOutboundMode/SIPProfileRegistration/ SIPProfileType/SelectedVideoInputSourceConnected/SipIceAndAnatConflict/ TemperatureCheck/ TLSVerifyRequiredCerts/TouchPanelConnection/TurnBandwidth/ UdpPortRangeViolation/ValidPasswords/VideoFromInternalCamera/VideoInputStability/ SpeakerTrackFrontPanelMountedCorrectly/SpeakerTrackMicrophoneConnection/ SpeakerTrackVideoInputs/SpeakerTrackEthernetConnection/ANATOnVCS/ ECReferenceDelay/AudioPairingSNR/AudioInternalSpeakerDisabled/ AbnormalCallTermination/HasActiveCallProtocol/SipOrH323ButNotBothEnabled/ PresentationSourceSelection/SoftwareUpgrade/ContactInfoMismatch> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 17: What's New In This Version
The full list of the changes, as well as a list of new commands are available in this chapter. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 18 (involving Cisco TelePresence Server, Cisco TelePresence MCU, and/or Cisco TelePresence Conductor) may be used instead. • MediaNet is no longer supported. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 19: Xconfiguration Changes In Ce8.0
Network [1] TrafficControl Mode SystemUnit CallLogging Mode NetworkServices CTMS Encryption SystemUnit MenuLanguage NetworkServices CTMS Mode Time OlsonZone NetworkServices HTTPS Mode UserInterface OSD EncryptionIndicator Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 20 <Off / HTTP+HTTPS / HTTPS> Default value: HTTP+HTTPS Renamed to: Cameras Camera [n] Brightness DefaultLevel Conference [1] AutoAnswer Delay Renamed to: Conference AutoAnswer Delay Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 21 Video SelfviewDefault PIPPosition Renamed to: SIP DefaultTransport Renamed to: Video Selfview Default PIPPosition SIP Profile [1] DisplayName Renamed to: SIP DisplayName Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 22: Xcommand Changes In Ce8.0
NEW: Axis: <All/Focus/PanTilt/Zoom> FarEndControl Preset Store Camera Preset Edit Key * NEW: DefaultPosition: <False/True> Logging ExtendedLogging * Message Echo Message FarendMessage Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 23 Time DateTime Get NEW: YourPassphrase: <S: 0, 255> SystemUnit DateTime Set Renamed to: Time DateTime Set OLD: Year: <2008..2037> NEW: Year: <2015..2037> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 24 Video PIP ActiveSpeaker Set Renamed to: xCommand Video ActiveSpeakerPIP Set xCommand Video PIP Presentation Set Renamed to: xCommand Video PresentationPIP Set Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 25: Xstatus Changes In Ce8.0
Conference Call [n] CalText (was Conference Site [n] CalText) Provisioning Server Conference Call [n] Preserved (was Conference Site [n] Preserved) Provisioning Software PreviousUpgrade * Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 26 Diagnostics Message [n] Type Conference ActiveSpeaker Mode NEW: TemperatureCheck, AudioInternalSpeakerDisabled, and ContactInfoMismatch added Renamed to: Conference SpeakerLock Mode to the value space Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 27 Renamed to: Diagnostics Message [n] * SystemUnit Software MaxAudioCalls Renamed to: Capabilities Conference MaxAudioCalls SystemUnit Software MaxVideoCalls Renamed to: Capabilities Conference MaxVideoCalls Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 28: About The Api
Cisco TelePresence SX10 API Reference Guide  Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 29: Api Fundamentals
Click your user name in the upper right corner and choose Change password in the drop down menu. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 30: Http/Https
POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 26 in this document. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 31: Api Output
To set ouput mode to XML, issue the command: </Layout> xPreferences outputmode xml </Video> </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 32: Using The Command Line
Echo <on/off> Refer to ”Configurations” on page can be used for advanced troubleshooting together with Cisco technical support. Systemtools are not a part of the If echo is set to the key inputs are displayed when enter- programming API. Refer to ”The SystemTools commands”...
Page 33: Command Line Shortcuts
XCOMMAND DIAL NUMBER: foo@bar.org *s Video Output Connector 3 Resolution Width: 1280 xcommand dial number: foo@bar.org ** end xCommand Dial Number: foo@bar.org Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 34: Commands
Write in: is separated with ‘:’. xConfiguration H323 Profile 1 H323Alias ID Result: *c xConfiguration H323 Profile 1 H323Alias ID: “changed@company.com” **end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 35: Events
** end and established. *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 36: Feedback Mechanism
Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name: “NameC” ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Connector[@item=’3’]/Name Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 37: Terminal Connections
/Status/Audio Write in: ** end Result: D: List the new feedback expressions. xFeedback list Write in: /Configuration/Video/MainVideoSource Result: ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 38: Using Http
Response: GET /configuration.xml HTTP/1.1 HTTP/1.1 204 No Content Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46 Server: nginx/1.8.0 4b990e18bfbb7fb048820c0e28955c54 Connection: keep-alive Set-Cookie: SessionId=; Max-Age=0; Path=/; HttpOnly Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 39: Getting Status And Configurations
<Configuration> </Command> <SystemUnit> Response <Name>newName</Name> HTTP/1.1 200 OK </SystemUnit> Content-Type: text/xml </Configuration> Content-Length: 91 <?xml version=”1.0”?> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 40: Feedback From Codec Over Http
Expression: <S: 1, 255> </HttpFeedback> Expression: <S: 1, 255> </Command> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 41: Translating From Terminal Mode To Xml
Terminal </Configuration> xCommand Video Layout AssignCall CallId: 2 LayoutId: 1 <Command> <Video> <Layout> <AssignCall command=”True”> <CallId>2</CallId> <LayoutId>1</LayoutId> </AssignCall> </Layout> </Video> </Command> Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 42: Dos And Don'ts
Although the amount of feedback may seem fine in the current version, the amount of feedback may grow in future releases. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 43: Xconfiguration Commands
Cisco TelePresence SX10 API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 44: Description Of The Xconfiguration Commands
Network [1] DNS Domain Name ..................58 xConfiguration Conference AutoAnswer Mute ..................52 xConfiguration Network [1] DNS Server [1..3] Address ................58 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 45 NetworkServices CDP Mode .................... 68 xConfiguration Provisioning ExternalManager Domain ................76 xConfiguration NetworkServices H323 Mode ..................68 xConfiguration NetworkServices HTTP Mode ..................68 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 46 Video Output Connector [1] CEC Mode ................91 xConfiguration SystemUnit Name ......................82 xConfiguration Video Output Connector [1] OverscanLevel ..............91 xConfiguration Video Output Connector [1] Resolution ................91 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 47 Video Selfview Default FullscreenMode ................92 xConfiguration Video Selfview Default PIPPosition ..................93 xConfiguration Video Selfview OnCall Mode .....................93 xConfiguration Video Selfview OnCall Duration ..................93 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 48: Audio Configuration
: Sunrise/Mischief/Ripples/Reflections/Vibes/Delight/Evolve/Playful/Ascent/ hearing their own audio. Once selected, echo cancellation is active at all times. Calculation/Mellow/Ringer Select a ringtone from the list. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 49: Xconfiguration Audio Input Microphone [2] Echocontrol Noisereduction
: Unique ID that identifies the microphone input. Range: 2..2 Dereverberation : Off/On Off: Turn off the dereverberation. On: Turn on the dereverberation. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 50: Xconfiguration Audio Output Line [1] Delay Delayms
HDMI output. The actual delay is HDMI-delay + DelayMs. The Audio Output Connectors Line [n] DelayMs status reports the actual delay. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 51: Xconfiguration Cameras Camera [1] Brightness Defaultlevel
Off: Display the image as other people see you. On: Display the image as you see yourself in a mirror. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 52: Xconfiguration Cameras Camera [1] Whitebalance Mode
Mute : Off/On Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 53: Xconfiguration Conference Autoanswer Delay
> In MultiSite calls: In order to have encrypted MultiSite conferences, all sites must support encryption. If not, the conference will be unencrypted. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 54: Xconfiguration Conference Farendcontrol Mode
Conference MaxReceiveCallRate: MaxReceiveCallRate The maximum receive call rate (kbps). where MaxReceiveCallRate : Integer (64..3072) The maximum receive call rate (kbps). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 55: Xconfiguration Conference Maxtotaltransmitcallrate
Requires user role: ADMIN Default value: "" USAGE: xConfiguration H323 Authentication LoginName: "LoginName" where LoginName : String (0, 50) The authentication login name. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 56: Xconfiguration H323 Authentication Password
Gatekeeper: The system uses a Gatekeeper to make an H.323 call. When choosing this option, the H323 Gatekeeper Address must also be configured. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 57: Xconfiguration H323 H323Alias E164
USAGE: xConfiguration H323 H323Alias ID: "ID" where : String (0, 49) The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 58: Xconfiguration H323 Nat Address
: Index that identifies the DNS server. Maximum three DNS servers are allowed. Range: 1..3 Address : String (0, 64) A valid IPv4 address or IPv6 address. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 59: Xconfiguration Network [1] Ieee8021X Mode
On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 60: Xconfiguration Network [1] Ieee8021X Password
The 802.1X Anonymous ID string. Ttls : Off/On Off: The EAP-TTLS protocol is disabled. On: The EAP-TTLS protocol is enabled (default). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 61: Xconfiguration Network [1] Ieee8021X Eap Tls
Network [1] IPv4 Assignment Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Define how the system will obtain its IPv4 address, subnet mask and gateway address. This setting only applies to systems on IPv4 networks.
Page 62: Xconfiguration Network [1] Ipv4 Address
DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 63: Xconfiguration Network [1] Ipv6 Address
: Index that identifies the network. Range: 1..1 A valid IPv6 address. : Integer (576..1500) Set a value for the MTU (bytes). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 64: Xconfiguration Network [1] Qos Mode
Signalling, Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are higher the priority. The default value is 0 (best effort). used to prioritize packets. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 65: Xconfiguration Network [1] Qos Diffserv Video
Set the priority of the video packets in the IP network - the higher the number, the the priority. The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 66: Xconfiguration Network [1] Qos Diffserv Signalling
Set the priority of the signalling packets in the IP network - the higher the number, the higher the priority. The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 67: Xconfiguration Network [1] Qos Diffserv Ntp
: Auto/Manual/Off xConfiguration Network QoS Diffserv NTP: Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. where If CDP is not available, VLAN is not enabled. : Index that identifies the network. Range: 1..1 Manual: The VLAN ID is set manually using the Network VLAN Voice VlanId setting.
Page 68: Xconfiguration Networkservices Https Verifyservercertificate
NetworkServices CDP Mode setting is switched Off, you cannot use the web interface. Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the If you need extra security (encryption and decryption of requests, and pages that are returned endpoint report certain statistics and device identifiers to a CDP-enabled switch.
Page 69: Xconfiguration Networkservices Https Verifyclientcertificate
NTP Server [n] Address setting for time reference. Off: The system will not use an NTP server. The NetworkServices NTP Server [n] Address setting will be ignored. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 70: Xconfiguration Networkservices Snmp Mode
These variables can then "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the be queried (set to ReadOnly) and sometimes set (set to ReadWrite) by managing applications.
Page 71: Xconfiguration Networkservices Snmp Systemlocation
Off: The welcome text is: Login successful On: The welcome text is: Welcome to <system name>; Software version; Software release date; Login successful. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 72: Peripherals Configuration
Note that only one Cisco Touch controller is supported in this version. : Unique ID that identifies the phonebook server. Range: 1..1 Requires user role: ADMIN...
Page 73: Xconfiguration Phonebook Server [1] Url
If the NAPTR responses have the "e" flag, external configurations will be requested. Otherwise internal configurations will be requested. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 74: Xconfiguration Provisioning Mode
: String (0, 64) Management System). A valid password. VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 75: Xconfiguration Provisioning Httpmethod
Provisioning ExternalManager AlternateAddress Select the HTTP method to be used for the provisioning. Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager (CUCM) and an alternate CUCM is available for redundancy. Define the address of the alternate Requires user role: ADMIN, USER CUCM.
Page 76: Xconfiguration Provisioning Externalmanager Path
When the video system emits ultrasound, Proximity clients can detect that they are close to the Default value: "" video system. In order to use a client, at least one of the Proximity services must be enabled (refer to the Proximity Services settings). In general, Cisco recommends enabling all the USAGE: Proximity services.
Page 77: Xconfiguration Proximity Services Contentshare Fromclients
On: Login is required when connecting to the codec via the serial port. Enabled: Content sharing to a Proximity client is enabled. Disabled: Content sharing to a Proximity client is disabled. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 78: Sip Configuration
A valid password. xConfiguration SIP DisplayName: "DisplayName" where DisplayName : String (0, 550) The name to be displayed instead of the SIP URI. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 79: Xconfiguration Sip Ice Mode
Rflx: Send media to the video system's public IP address, as seen by the TURN server. Relay: Send media to the IP address and port allocated on the TURN server. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 80: Xconfiguration Sip Proxy [1
USAGE: xConfiguration SIP URI: "URI" where : String (0, 255) An address (URI) that is compliant with the SIP URI syntax. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 81: Standby Configuration
PrivacyPosition: When the video system enters standby, the camera turns to a sideways Set the standby delay (minutes). position for privacy. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 82: Xconfiguration Standby Wakeupaction
: String (0, 50) DefaultCameraPosition: When the video system leaves standby, the camera moves to Define the system name. the factory default position. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 83: Time Configuration
America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/ Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/ Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/ Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 84 Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/ Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/ Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 85: Userinterface Configuration
Mode : Off/On Off: There is no key tone sound effect. On: The key tone sound effect is turned on. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 86: Usermanagement Configuration
STARTTLS: Connect to LDAP server on port 389, then send STARTTLS to enable TLS where encryption. Address : String (0, 255) A valid IPv4 address, IPv6 address or hostname. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 87: Xconfiguration Usermanagement Ldap Minimumtlsversion
Use the video system’s web interface to manage the list of trusted CAs (see more details in the administrator guide). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 88: Xconfiguration Usermanagement Ldap Attribute
: Unique ID that identifies the video input connector. Range: 1..3 Mode : Connector 1: Off/On Connector 2,3: Off Off: Disable camera control. On: Enable camera control. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 89: Xconfiguration Video Input Connector [1..3] Cameracontrol Cameraid
Use this when a whiteboard camera is connected to the video input. other: Use this when the other options do not match. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 90: Xconfiguration Video Input Connector [2..3] Presentationselection
Video Monitors: Monitors as in manual mode. where Monitors : Single Single: The layout is shown on the video system's monitor. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 91: Xconfiguration Video Output Connector [1] Cec Mode
Resolution : Auto Auto: The system will automatically try to set the optimal resolution based on negotiation with the connected monitor. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 92: Xconfiguration Video Presentation Defaultsource
On: self-view is switched on when leaving a call. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 93: Xconfiguration Video Selfview Default Pipposition
Duration : Integer (1..60) Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 94: Xcommand Commands
Cisco TelePresence SX10 API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 95 Call FarEndControl Camera Move ..................101 xCommand Camera Preset Remove ....................... 108 xCommand Call FarEndControl Camera Stop ..................102 xCommand Camera Preset Show ......................108 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 96 Phonebook Contact Modify ....................116 xCommand Standby ResetTimer......................123 xCommand Phonebook ContactMethod Add ..................116 xCommand Phonebook ContactMethod Delete ..................117 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 97 UserInterface OSD Key Release ...................129 UserManagement commands ......................130 xCommand UserManagement RemoteSupportUser Create ..............130 xCommand UserManagement RemoteSupportUser Delete ..............130 xCommand UserManagement RemoteSupportUser DisablePermanently ..........130 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 98: Audio Commands
Audio SoundsAndAlerts Ringtone Play RingTone: "RingTone" where USAGE: xCommand Audio Volume Mute RingTone: String (1, 100) The name of the ringtone. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 99: Xcommand Audio Volume Set
Requires user role: ADMIN, USER Stop all VuMeters. USAGE: Requires user role: ADMIN, USER xCommand Audio Volume Unmute USAGE: xCommand Audio VuMeter StopAll Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 100: Bookings Commands
Id: String (0, 128) The booking ID of a call or conference. Offset: Integer (0..65534) Offset number of bookings for this search. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 101: Call Commands
Call command to see the CallId. Value: Left/Right/Up/Down/ZoomIn/ZoomOut DTMFString: String (0, 32) Select the action for how to move the camera. Enter the DTMF string. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 102: Xcommand Call Farendcontrol Roompreset Activate
Call command to see the CallId. PresetId: Integer (1..15) The ID of the preset that is stored on the far end codec. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 103: Xcommand Call Ignore
The CallID is returned when the xCommand Dial command is run. During a call you can run the xStatus Call command to see the CallId. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 104: Callhistory Commands
Requires user role: ADMIN, USER USAGE: xCommand CallHistory DeleteAll [Filter: Filter] where Filter: All/Missed/Placed/Received You can filter which calls to delete. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 105: Xcommand Callhistory Get
CallHistoryId for the call in question. CallHistoryId for the call in question. Order: OccurrenceTime/OccurrenceFrequency Define the order in which the previous calls are presented. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 106: Camera Commands
USAGE: xCommand Camera Preset Activate PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to activate. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 107: Xcommand Camera Preset Activatedefaultposition
Note that each camera can only have one default position, so if set, the old default preset will automatically be marked as not default. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 108: Xcommand Camera Preset List
USAGE: xCommand Camera Preset Remove PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to remove. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 109: Xcommand Camera Preset Store
Note that each camera can hold only one default position, so if set, the old default preset will automatically be marked as not default. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.
Page 110: Xcommand Camera Triggerautofocus
Releases locked speaker set by xCommand Conference SpeakerLock Set. Default voice switching is switched back on. Requires user role: ADMIN, USER USAGE: xCommand Conference SpeakerLock Release Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 111: Xcommand Conference Speakerlock Set
You can filter the diagnostics results to alerts, all or none. If not set, the result will show Identify CallID for the remote participant. Only relevant if Target is set to "remote". all results. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 112: Dial Commands
You can have from 1 to 15 XPath expressions. DisplayName: String (0, 255) The display name of the remote participant. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 113: Peripherals Commands
SoftwareInfo: String (0, 100) Software version the device is running. Type: Byod/ControlSystem/Other/TouchPanel Define the type of device you are connecting to. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 114: Xcommand Peripherals Pairing Devicediscovery Start
Peripherals Pairing Pair MacAddress: "MacAddress" where MacAddress: String (1, 1450) Enter the MAC address for the ISDN Link you wish to pair to the endpoint. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 115: Phonebook Commands
CallRate: Integer (0..6000) Set a call rate. CallType: Audio/Video Select a call type (audio or video). Device: Mobile/Other/Telephone/Video Select the device type. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 116: Xcommand Phonebook Contact Modify
Number, Protocol, CallRate, CallType and Device. You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact Requires user role: ADMIN, USER method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.
Page 117: Xcommand Phonebook Contactmethod Modify
The phone number or address of the contact. Protocol: Auto/H320/H323/SIP/Spark Select protocol. CallRate: Integer (0..6000) Set a call rate. CallType: Audio/Video Select a call type (audio or video). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 118: Xcommand Phonebook Folder Add
The unique identifier for the folder. The identifier will be returned by an xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 119: Xcommand Phonebook Search
Limit: Integer (0..65534) Limit the number of records in the result set to this number. For example, if the limit is Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 120: Presentation Commands
Select which local presentation you wish to stop, identified by presentation instance. PresentationSource: Integer (2..2) Select which local presentation you wish to stop, identified by source number. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 121: Proximity Commands
Requires user role: ADMIN, USER USAGE: xCommand RoomPreset Clear PresetId: PresetId where PresetId: Integer (1..15) The ID of the preset you want to delete. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 122: Xcommand Roompreset Store
In non-persistent mode local phone book is deleted when the system reboots. DHCP: NonPersistent/Persistent In non-persistent mode all IP related information is deleted when the system reboots. ConfirmAndReboot: Yes Reboots the system. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 123: Xcommand Security Session List
Requires user role: ADMIN, USER USAGE: xCommand Standby ResetTimer Delay: Delay where Delay: Integer (1..480) Set the delay in minutes. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 124 USAGE: TrailingAction] xCommand SystemUnit OptionKey List where Confirm: Yes TrailingAction: NoAction/Restart/Shutdown Select Shutdown or NoAction to override the default behaviour (Restart). Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 125 Requires user role: ADMIN USAGE: xCommand SystemUnit SoftReset Confirm: Confirm where Confirm: Yes Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 126 Delete all user interface extensions (widgets) from the video system. Second: Integer (0..59) Requires user role: ADMIN USAGE: xCommand UserInterface Extensions Clear Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 127 UserInterface Message Prompt Clear [FeedbackId: "FeedbackId"] where FeedbackId: String (0, 255) The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 128 Enter the text to appear on the feedback options. Option.4: String (0, 255) Enter the text to appear on the feedback options. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 129 Requires user role: ADMIN USAGE: xCommand UserInterface OSD Key Click Key: where Key: 0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/ Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/ SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut/+/- Define the remote key to press. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 130 Disable the creation of new remote support users. To enable the remote support user again you must factory reset your system. Requires user role: ADMIN USAGE: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Confirm where Confirm: Yes Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 131: Video Commands
The identifier (ID) of the connector. Connector [n] has ID n. Run the following API command to find the ID: xStatus Video Input Connector. The connector ID is also printed on the codec connector panel. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 132 Select one of the predefined positions. Select the position for the self-view image. OnMonitorRole: First/Fourth/Second/Third Displays self-view on monitors with this role. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 133 Cisco TelePresence SX10 API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 134: Xstatus Commands
Cisco TelePresence SX10 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 135: Description Of The Xstatus Commands
Capabilities Conference MaxCalls ....................145 xStatus Call [n] Encryption Type .......................142 xStatus Capabilities Conference MaxVideoCalls ..................146 xStatus Call [n] FacilityServiceId ......................142 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 136 Network 1 IPv4 Address ......................156 xStatus Diagnostics Message [n] Type ..................... 151 xStatus Network 1 IPv4 Gateway ......................156 xStatus Network 1 IPv4 SubnetMask .......................156 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 137 Provisioning Software UpgradeStatus VersionId ................ 161 xStatus Provisioning Status ........................161 Standby status ............................ 166 xStatus Standby ............................166 xStatus Standby State ..........................166 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 138 Video Selfview Mode ........................177 xStatus Video Selfview OnMonitorRole ....................177 Video status ............................172 xStatus Video Selfview PIPPosition ......................177 xStatus Video ............................172 Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 139: Audio Status
*s Audio Input Connectors Microphone 2 ConnectionStatus: Connected ** end Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 140: Xstatus Audio Output Connectors Line [N] Delayms
Shows whether the endpoint volume is set to mute. Value space of the result returned: Off/On Example: xStatus Audio VolumeMute *s Audio VolumeMute: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 141: Call Status
Value space of the result returned: Unanswered/Ignored/Autoanswered/Answered xStatus Call [n] DeviceType Example: Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints xStatus Call AnswerState (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities. *s Call 5 AnswerState: Answered...
Page 142: Xstatus Call [N] Holdreason
Call 27 Encryption Type Example: *s Call 27 Encryption Type: "None" xStatus Call 27 PlacedOnHold ** end *s Call 27 PlacedOnHold: False ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 143: Xstatus Call [N] Protocol
Call to find the call identity. Value space of the result returned: String Example: xStatus Call 27 RemoteNumber *s Call 27 RemoteNumber: "5585232" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 144: Cameras Status
** end Value space of the result returned: Auto/On/Off Example: xStatus Cameras Camera 1 Flip *s Camera 1 Flip: "Off" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 145: Xstatus Cameras Camera [N] Serialnumber
Shows the the maximum number of simultaneous calls. Value space of the result returned: 0..5 Example: xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 146: Xstatus Capabilities Conference Maxvideocalls
Value space of the result returned: On/Off Example: xStatus Conference Call Capabilities FarendMessage Mode *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 147: Xstatus Conference Call [N] Capabilities Fecc Mode
*s Conference Call 2 Capabilities FECC Source 1 SourceId: 6 xStatus Conference Call 2 Capabilities FECC NumberOfSources ** end *s Conference Call 2 Capabilities FECC NumberOfSources: 5 ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 148: Xstatus Conference Call [N] Capabilities Hold
Conference Call 2 SoftwareID *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 SoftwareID: "CE8" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 149: Xstatus Conference Donotdisturb
Shows the identity of the system that sends the presentation. Value space of the result returned: Integer Example: xStatus Conference Presentation CallId *s Conference Presentation CallId: 0 ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 150: Xstatus Conference Presentation Localinstance [N] Sendingmode
Shows the status of the secondary video stream. Value space of the result returned: On/Off Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 151: Diagnostics Status
*s Diagnostics Message 4 Level: Warning ECReferenceDelay/AudioPairingNoise/AudioPairingRate/AudioPairingSNR/ AudioPairingInterference/AudioPairingTokenDecode/AudioInternalSpeakerDisabled/ ** end AbnormalCallTermination/HasActiveCallProtocol/SipOrH323ButNotBothEnabled/ PresentationSourceSelection/SoftwareUpgrade/PlatformSanity/ContactInfoMismatch/ ProximityContentShareToClientsWithMultistream Example: xStatus Diagnostics Message type *s Diagnostics Message 1 Type: InvalidAdminPassword ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 152: H323 Status
H323 Gatekeeper Reason Example: *s H323 Gatekeeper Reason: "" xStatus H323 Mode Status ** end *s H323 Mode Status: "Disabled" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 153: Httpfeedback Status
Identifies the name of the switch in form of a character string. Value space of the result returned: String Example: xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 154: Xstatus Network 1 Cdp Duplex
Network CDP PortID xStatus Network CDP SysObjectID *s Network 1 CDP PortID: "GigabitEthernet1/0/23" *s Network 1 CDP SysObjectID: "" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 155: Xstatus Network 1 Cdp Version
Example: xStatus Network 1 CDP Version xStatus Network 1 DNS Domain Name *s Network 1 CDP Version: "Cisco IOS Software, C3560CX Software (C3560CX- *s Network 1 DNS Domain Name: "www.example.com www.example.int" UNIVERSALK9-M), Version 15.2(3)E, RELEASE SOFTWARE (fc4)*Technical Support: ** end http://www.cisco.com/techsupport*Copyright (c) 1986-2014 by Cisco Systems,...
Page 156: Xstatus Network 1 Ethernet Speed
Network 1 IPv6 Gateway *s Network 1 IPv4 Gateway: "192.0.2.10" *s Network 1 IPv6 Gateway: "" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 157: Xstatus Network 1 Vlan Voice Vlanid
Value space of the result returned: String Example: xStatus NetworkServices NTP Address *s NetworkServices NTP Address: "12.104.193.12 64.104.222.16 144.254.15.121" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 158: Xstatus Networkservices Ntp Status
Value space of the result returned: String Example: xStatus Peripherals ConnectedDevice 1007 Name *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 159: Xstatus Peripherals Connecteddevice [N] Softwareinfo
Value space of the result returned: Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTrack/TouchPanel Example: xStatus Peripherals ConnectedDevice 1001 Type *s Peripherals ConnectedDevice 1001 Type: TouchPanel ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 160: Provisioning Status
** end String Example: xStatus Provisioning Software Current VersionId *s Provisioning Software Current VersionId: "s52020ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 161: Xstatus Provisioning Software Upgradestatus Sessionid
String ** end Example: xStatus Provisioning Software UpgradeStatus URL *s Provisioning Software UpgradeStatus URL: "http://.../s52020ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 162: Proximity Status
Persistent is the default mode. Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency Configurations *s Security Persistency Configurations: Persistent ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 163: Xstatus Security Persistency Dhcp
*s Security Persistency LocalPhonebook: Persistent Value space of the result returned: ** end Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 164: Xstatus Sip Callforward Displayname
SIP CallForward URI xStatus SIP Proxy 1 Address *s SIP CallForward URI: "" *s SIP Proxy 1 Address: "192.0.2.50" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 165: Xstatus Sip Proxy [N] Status
*s SIP Registration 1 Authentication: Off String ** end Example: xStatus SIP Registration 1 URI *s SIP Registration 1 URI: "firstname.lastname@company.com" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 166: Xstatus Sip Secure
Shows whether or not the SSL certificate of the server that the video system / codec tries to xStatus Standby State register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. *s Standby State: Off ** end True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found...
Page 167: Systemunit Status
SystemUnit Hardware Module CompatibilityLevel *s SystemUnit Hardware Monitoring Fan 1 Status: "locked on 1096 rpm" The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The ** end endpoints running TC software are manufactured with a new version of the flash memory.
Page 168: Xstatus Systemunit Notifications Notification [N] Type
SystemUnit Software DisplayName xStatus SystemUnit ProductId *s SystemUnit Software DisplayName: "Display Name" *s SystemUnit ProductId: "Cisco TelePresence Codec SX80" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 169: Xstatus Systemunit Software Name
SystemUnit State NumberOfActiveCalls xStatus SystemUnit Software OptionKeys RemoteMonitoring *s SystemUnit State NumberOfActiveCalls: 0 *s SystemUnit Software OptionKeys RemoteMonitoring: "true" ** end ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 170: Xstatus Systemunit State Numberofinprogresscalls
Shows the number of seconds since the last restart of the codec. Value space of the result returned: Integer Example: xStatus SystemUnit Uptime *s SystemUnit Uptime: 597095 ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 171: Userinterface Status
** end xStatus UserInterface Extensions Widget [n] WidgetId Returns the unique identifier for a widget in the touch controller user interface. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 172: Xstatus Video Activespeaker Pipposition
*s Video Input Connector 1 Connected: True Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 173: Xstatus Video Input Mainvideosource
*s Video Input Source 1 Resolution FormatStatus: Ok xStatus Video Input Source 1 Resolution Height ** end *s Video Input Source 1 Resolution Height: 1080 ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 174: Xstatus Video Input Source [N] Resolution Refreshrate
Video Output *s Video Layout LayoutFamily Local: "equal" Shows the top level overview of the video output status. ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 175: Xstatus Video Output Connector [N] Connected
Value space of the result returned: String Example: xStatus Video Output Connector 1 ConnectedDevice Name *s Video Output Connector 1 ConnectedDevice Name: "G2420HDBL" ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 176: Xstatus Video Output Connector [N] Connecteddevice Preferredformat
** end 120..3000 Example: xStatus Video Output Connector 1 Resolution Height *s Video Output Connector 1 Resolution Height: 1080 ** en Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 177: Xstatus Video Presentation Pipposition
Shows whether selfview mode is set on or not. Value space of the result returned: On/Off Example: xStatus Video Selfview Mode *s Video Selfview Mode: Off ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 178: Appendices
Cisco TelePresence SX10 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 179: About Startup Scripts
Use the codec’s web interface to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 180: The Systemtools Commands
The default value “0” indicates no restrictions. Network debug command. Max failed login attempts [0]? • Number of failed logins until a user is set inactive. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 181 • Maximum consecutive equal digits in PINs. Minimum number of digits in PINs [0]? • Minimum number of digits in PINs. Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 182: About Disconnect Cause Types
DisconnectEvent *e CallDisconnect CauseValue: 1 CauseType: “LocalDisconnect” CauseString: “” OrigCallDirection: “outgoing” RemoteURI: “firstname.lastname@company.com” CallId: 89 CauseCode: 0 CauseOrigin: SIP ** end Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 183: User Documentation On The Cisco Web Site
Troubleshoot and Alerts > Troubleshooting Guides • Knowledge base articles: Brief articles that give advice on installation, interoperability, configuration, and other frequently asked questions Cisco TelePresence SX10 API Reference Guide CE8.2, SEPTEMBER 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 184 IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, On our web site you will find an overview of the worldwide Cisco contacts. WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM Go to: http://www.cisco.com/web/siteassets/contacts...

This manual is also suitable for:

Telepresence sx80

Cisco TelePresence SX10 Reference Manual

What's in this Guide?

Description of the Xconfiguration Commands

Description of the Xcommand Commands

Quick Links

Chapters

Related Manuals for Cisco TelePresence SX10

Summary of Contents for Cisco TelePresence SX10