Page 1 About the API xConfiguration xCommand xStatus Appendices Collaboration Endpoint Software 9.1 JUNE 2017 Application Programming Interface (API) Reference Guide Cisco TelePresence SX10 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 2: Table Of Contents
User documentation on the Cisco web site ......187 Events ................... 21 Feedback mechanism ............22 Feedback expressions ............22 Terminal connections ............23 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 4: We Recommend You Visit Our Web Site Regularly For Updated About This Guide
For Spark registred systems, go to: • Cisco TelePresence SX10 Quick Set https://support.ciscospark.com Guidelines for how to find the documentation on the Cisco The guide describes the API for on-premise registered video web site are included in theUser documentation on the...
Page 5: Go To:Http://Www.cisco.com/Go/Sx-Docs What's New In Ce9.1
The system will wake to the Halfwake state when a user pairs a Cisco Proximity client to the system. http://www.cisco.com/c/en/us/support/collabo- ration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 6 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 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 7 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) Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 8 / ConfigurationFile / DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus / PresenterTrack / H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey / IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 9: What's New In Ce9.0
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. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 10 Audio Output Line [n] * Audio SoundsAndAlerts * Cameras Camera [n] * Conference DefaultCall Rate Conference DoNotDisturb DefaultTimeout Peripherals Profile * SerialPort Mode Standby * Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 11 Audio SoundsAndAlerts Ringtone Play Audio Sound Stop Peripherals Connect Peripherals List Standby Activate Standby Deactivate SystemUnit Boot UserInterface Extensions Clear UserInterface Extensions List Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 12 ITLinstallation, InvalidSIPTransportConfig, LockDown, RoomControl, Cameras Camera[n] Position Tilt MediaBlockingDetected, NetLinkStatus, NetSpeedAutoNegotiated, NetworkQuality, NTPStatus, OSDVideoOutput, OutputConnectorLocations, ProvisioningDeveloperOptions, Cameras Camera[n] Position Zoom ProvisioningStatus, SIPEncryption, SIPListenPortAndOutboundMode, SIPProfileRegistration, Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 13 Video Input Connector[n] Type Video Input Source[n] ConnectorId Video Input Source[n] FormatStatus Video Input Source[n] FormatType Video Input Source[n] Resolution Height Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 14: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 15: Api Fundamentals
POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 24 in this document. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 16: Serial Connection Over Micro Usb
Such a user can also create in-room controls. Cisco Spark registered systems If a video system is registered to Cisco’s cloud service (Cisco Spark), only local users with the INTEGRATOR and ROOMCONTROL user roles are available. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017.
Page 17: Api Output
To set output mode to XML, issue the command: </Audio> xPreferences outputmode xml </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 18: 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 19: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 20: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 21: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 22: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 23: Terminal Connections
Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 24: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 25: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 26: Feedback From Codec Over Http
Expression: <S: 1, 255> CallDisconnect</Expression> Expression: <S: 1, 255> <Expression item=”3”>/Status/Call</ Expression: <S: 1, 255> Expression> Expression: <S: 1, 255> </Register> </HttpFeedback> </Command> Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 27: Translating From Terminal Mode To Xml
Example 2: Assigning volume level </Input> </Video> Terminal </Configuration> xCommand Audio Volume Set Level: 50 <Command> <Audio> <Volume> <Set command=”True”> <Level>50</Level> </Set> </Volume> </Audio> </Command> Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 28: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 29: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 30: Description Of The Xconfiguration Commands
Conference AutoAnswer Mute ..................39 xConfiguration Network [1] IEEE8021X Mode .....................45 xConfiguration Conference AutoAnswer Delay ..................39 xConfiguration Network [1] IEEE8021X TlsVerify ..................45 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 31 NetworkServices H323 Mode ...................55 xConfiguration Provisioning ExternalManager Address ................63 xConfiguration NetworkServices HTTP Mode ...................55 xConfiguration Provisioning ExternalManager AlternateAddress ..............64 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 32 Standby StandbyAction .....................70 xConfiguration Video Input Connector [2..3] PresentationSelection ............78 xConfiguration Standby WakeupAction......................70 xConfiguration Video Input Connector [1..3] Visibility ................79 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 33 Video Selfview Default FullscreenMode ................81 xConfiguration Video Selfview Default PIPPosition ..................81 xConfiguration Video Selfview OnCall Mode .....................82 xConfiguration Video Selfview OnCall Duration ..................82 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 34: Audio Configuration
When set to InCallOnly this will prevent the audio-system from being muted by mistake. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 35: Xconfiguration Audio Input Microphone [2] Echocontrol Mode
NoiseReduction Off: Turn off the noise reduction. On: Turn on the noise reduction. Recommended in the presence of low frequency noise. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 36: Xconfiguration Audio Input Microphone [1
DelayMs where : Unique ID that identifies the audio line output. Range: 1..6 : Integer (0..290) DelayMs The delay in milliseconds. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 37: Cameras Configuration
Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras Camera [n] Brightness DefaultLevel setting. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 38: Xconfiguration Cameras Camera [1] Focus Mode
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 39: Xconfiguration Conference Defaultcall Rate
: Off/On Mute Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 40: Xconfiguration Conference Donotdisturb Defaulttimeout
> 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 41: Xconfiguration Conference Maxtransmitcallrate
Conference MaxTotalReceiveCallRate: MaxTotalReceiveCallRate : Off Mode where Off: Multistream is disabled. : Integer (64..3072) MaxTotalReceiveCallRate The maximum receive call rate (kbps). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 42: H323 Configuration
H323 Gatekeeper Address must also be configured. xConfiguration H323 Authentication LoginName: "LoginName" where : String (0, 50) LoginName The authentication login name. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 43: Xconfiguration H323 Encryption Keysize
The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" : String (0, 255) Address A valid IPv4 address, IPv6 address or DNS name. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 44: Xconfiguration H323 Nat Mode
"My IP Address: 10.0.2.1". If the H323 NAT Address is wrong or not set, H.323 calls cannot be set up. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 45: Network Configuration
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 46: Xconfiguration Network [1] Ieee8021X Useclientcertificate
: Index that identifies the network. Range: 1..1 AnonymousIdentity The 802.1X Anonymous ID string. : String (0, 64) Identity The user name for 802.1X authentication. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 47: Xconfiguration Network [1] Ieee8021X Eap Md5
Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN by Agere Systems, Proxim and Avaya. clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN, USER Requires user role: ADMIN, USER...
Page 48: Xconfiguration Network [1] Ipstack
Network IPv4 Gateway and Network IPv4 SubnetMask settings (static addresses). DHCP: The system addresses are automatically assigned by the DHCP server. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 49: Xconfiguration Network [1] Ipv4 Subnetmask
DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 50: Xconfiguration Network [1] Ipv6 Dhcpoptions
Network MTU: where : Index that identifies the network. Range: 1..1 : Integer (576..1500) Set a value for the MTU (bytes). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 51: Xconfiguration Network [1] Qos Diffserv Audio
Set the priority of the video 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 52: Xconfiguration Network [1] Qos Diffserv Data
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). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 53: Xconfiguration Network [1] Qos Diffserv Icmpv6
: Index that identifies the network. Range: 1..1 : String (0, 255) Allow A valid IPv4 address or IPv6 address. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 54: Xconfiguration Network [1] Speed
: Auto/Manual/Off Mode : Auto/10half/10full/100half/100full Speed Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. Auto: Autonegotiate link speed. If CDP is not available, VLAN is not enabled. 10half: Force link to 10 Mbps half-duplex.
Page 55: Xconfiguration Networkservices Https Server Minimumtlsversion
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 56: Xconfiguration Networkservices Https Stricttransportsecurity
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 57: Xconfiguration Networkservices Ntp Server [1..3] Address
: Identifies the SNMP host. Maximum three SNMP hosts are allowed. Range: 1..3 : String (0, 255) Address A valid IPv4 address, IPv6 address or DNS name. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 58: Xconfiguration Networkservices Snmp Communityname
Requires user role: ADMIN in order to receive a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the Default value: "" same SNMP Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 59: Xconfiguration Networkservices Telnet Mode
IP address manually in order to pair a Touch controller to the video system. On: UPnP is enabled. The video system advertises its presence until the timeout period expires. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 60: Peripherals Configuration
Peripherals Profile TouchPanels Define the number of Cisco Touch controllers that are expected to be connected to the video system. This information is used by the video system's diagnostics service. If the number of connected Touch controllers does not match this setting, the diagnostics service will report it as an inconsistency.
Page 61: Phonebook Configuration
CUCM: The phonebook is located on the Cisco Unified Communications Manager. Spark: The phonebook is located on Spark. TMS: The phonebook is located on the Cisco TelePresence Management Suite server. VCS: The phonebook is located on the Cisco TelePresence Video Communication Server.
Page 62: Provisioning Configuration
Spark: Push configurations to the video system from Spark. TMS: Push configurations to the video system from TMS (Cisco TelePresence Management System). VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017.
Page 63: Xconfiguration Provisioning Loginname
USAGE: xConfiguration Provisioning ExternalManager Address: "Address" where : String (0, 64) Address A valid IPv4 address, IPv6 address or DNS name. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 64: Xconfiguration Provisioning Externalmanager Alternateaddress
Provisioning ExternalManager AlternateAddress xConfiguration Provisioning ExternalManager Path Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Define the Path to the external manager / provisioning system. This setting is required when (CUCM) and an alternate CUCM is available for redundancy. Define the address of the alternate several management services reside on the same server, i.e.
Page 65: Proximity Configuration
Requires user role: ADMIN, USER video system. In order to use a client, at least one of the Proximity services must be enabled Default value: Enabled (refer to the Proximity Services settings). In general, Cisco recommends enabling all the Proximity services. USAGE:...
Page 66: Serialport Configuration
Off: The user can access the codec via the serial port without any login. On: Login is required when connecting to the codec via the serial port. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 67: Xconfiguration Sip Defaulttransport
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 68: Xconfiguration Sip Listenport
Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Turn Password: "Password" where : String (0, 128) Password A valid password. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 69: Xconfiguration Sip Uri
Requires user role: ADMIN, INTEGRATOR Default value: 10 USAGE: xConfiguration Standby Delay: Delay where : Integer (1..480) Delay Set the standby delay (minutes). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 70: Xconfiguration Standby Bootaction
: None/PrivacyPosition StandbyAction None: No action. PrivacyPosition: When the video system enters standby, the camera turns to a sideways position for privacy. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 71: Systemunit Configuration
DD_MM_YY: The date January 30th 2010 will be displayed: 30.01.10 MM_DD_YY: The date January 30th 2010 will be displayed: 01.30.10 YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 72: Xconfiguration Time Zone
Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/ America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/ Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/ Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 73: Userinterface Configuration
: Off/On Mode Off: There is no key tone sound effect. On: The key tone sound effect is turned on. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 74: Xconfiguration Userinterface Language
USAGE: xConfiguration UserManagement LDAP Server Address: "Address" where : String (0, 255) Address A valid IPv4 address, IPv6 address or hostname. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 75: Xconfiguration Usermanagement Ldap Server Port
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 76: Xconfiguration Usermanagement Ldap Admin Filter
UserManagement LDAP Admin Group: "Group" where : String (0, 255) Group The distinguishing name of the AD group. Example: "CN=admin_group, OU=company groups, DC=company, DC=com" Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 77: Video Configuration
Whiteboard: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 78: Xconfiguration Video Input Connector [1
Sharpness: Gives the highest possible resolution. Used when you want the highest as in manual mode. quality of detailed images and graphics. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 79: Xconfiguration Video Input Connector [1..3] Visibility
Default value: Single USAGE: xConfiguration Video Monitors: Monitors where : Single Monitors Single: The layout is shown on the video system's monitor. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 80: Xconfiguration Video Output Connector [1] Overscanlevel
: Auto Resolution Auto: The system will automatically try to set the optimal resolution based on negotia- tion with the connected monitor. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 81: Xconfiguration Video Selfview Default Fullscreenmode
LowerLeft: The self-view PiP will appear in the lower left corner of the screen. LowerRight: The self-view PiP will appear in the lower right corner of the screen. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 82: Xconfiguration Video Selfview Oncall Mode
: Integer (1..60) Duration Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 83: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 84: Description Of The Xcommand Commands
Camera PositionSet ....................... 96 Call commands ............................. 91 xCommand Camera Preset Activate ......................97 xCommand Camera Preset ActivateDefaultPosition ..................97 xCommand Call Accept..........................91 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 85 Security Session List ......................113 Phonebook commands ........................105 xCommand Security Session Terminate ....................114 xCommand Phonebook Contact Add ......................105 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 86 UserInterface Extensions Widget UnsetValue ..............119 xCommand Video PresentationView Set ....................126 xCommand UserInterface Message Alert Clear ..................119 xCommand Video Selfview Set ........................126 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 87: Audio Commands
: Integer (1..50) Volume The volume for the test signal. In a noisy environment a higher volume gives more reliable and robust results. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 88: Xcommand Audio Sound Play
Audio SoundsAndAlerts Ringtone List : Integer (1..10) Steps Choose the number of steps to increase the volume with. One step is 0.5 dB. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 89: Xcommand Audio Volume Mute
Audio Volume ToggleMute Toggle the loudspeaker between muted and unmuted. Requires user role: ADMIN, USER USAGE: xCommand Audio Volume ToggleMute Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 90: Xcommand Audio Vumeter Stop
Stop all VU meters. The booking ID of a call or conference. Requires user role: ADMIN, USER USAGE: xCommand Audio VuMeter StopAll Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 91: Xcommand Call Disconnect
The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 92: Xcommand Call Dtmfsend
Call command to see the CallId. : Integer (1..15) PresetId The ID of the preset that is stored on the far end codec. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 93: Xcommand Call Farendcontrol Source Select
Call Join CallId: CallId where : Integer (0..65534) CallId You can have from 1 to 10 CallId parameters in the same command. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 94: Xcommand Call Reject
Call command to see the CallId. You can filter which calls to delete. : String (0, 255) Number The number the call is transfered to. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 95: Xcommand Callhistory Deleteentry
Allows you to set the command to apply to a specified display name or call back number. : Integer (0..65534) CallHistoryId CallHistoryId for the call in question. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 96: Xcommand Callhistory Recents
Move the camera to the left or right. : Integer (-2500..2500) Tilt Move the camera up or down. : Integer (0..8500) Zoom Zoom in or out. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 97: Xcommand Camera Preset Activate
The ID of the camera preset you want to activate. If CameraId is not specified, all cameras will be set in their respective default position, if one is defined. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 98: Xcommand Camera Preset List
Camera Preset Remove PresetId: PresetId where : Integer (1..35) PresetId The ID of the camera preset you want to remove. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 99: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 100: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 101: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 102: Dial Commands
: Integer (1..999999999) Appearance Internal usage only. : String (0, 255) DisplayName The display name of the remote participant. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 103: Xcommand Httpfeedback Register
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER registering to one of them. USAGE: Note: Avoid using FeedbackSlot 3 in an environment where Cisco TelePresence Management Suite (TMS) is used as TMS uses this feedbackslot to register its xCommand Peripherals Connect [HardwareInfo: "HardwareInfo"] ID: "ID" [Name: expressions.
Page 104: Xcommand Peripherals Heartbeat
Enter the MAC address for the ISDN Link you wish to pair to the endpoint. Limit the search to currently connected devices. : All/ControlSystem/ISDNLink/Other/TouchPanel Type Limit the search by device type. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 105: Xcommand Peripherals Pairing Unpair
: Mobile/Other/Telephone/Video Device Select the device type. : Untagged/Favorite Tag the contact as a Favorite, or untag an already tagged contact. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 106: Xcommand Phonebook Contact Delete
: String (0, 255) Title The title of the contact. : Untagged/Favorite Tag the contact as a Favorite, or untag an already tagged contact. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 107: Xcommand Phonebook Contactmethod Add
You can add several contact methods to a contact. Note that only the first contact method USAGE: will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact xCommand Phonebook ContactMethod Delete ContactId: "ContactId" ContactMethodId: method may have been created when issuing the xCommand Phonebook Contact Add "ContactMethodId"...
Page 108: Xcommand Phonebook Contactmethod Modify
Set a call rate. Folder Add command was issued to make the folder. : Audio/Video CallType Select a call type (audio or video). Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 109: Xcommand Phonebook Folder Modify
10, the ResultSet will contain only 10 entries (Contacts and Folders) even if the total number of hits is larger. The maximum limit is 1000. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 110: Presentation Commands
Select which local presentation you wish to stop, identified by presentation instance. : Integer (2..2) PresentationSource Select which local presentation you wish to stop, identified by source number. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 111: Provisioning Commands
This command will log you out of your Extension Mobility profile. Requires user role: ADMIN, USER Requires user role: ADMIN, USER USAGE: USAGE: xCommand Provisioning StartUpgrade xCommand Provisioning ExtensionMobility Logout Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 112: Proximity Commands
Requires user role: ADMIN, USER USAGE: xCommand RoomPreset Clear PresetId: PresetId where : Integer (1..15) PresetId The ID of the preset you want to delete. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 113: Xcommand Roompreset Store
ConfirmAndReboot Reboots the system. xCommand Security Session List List active sessions. Requires user role: ADMIN, USER USAGE: xCommand Security Session List Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 114: Xcommand Security Session Terminate
Requires user role: ADMIN, USER USAGE: xCommand Standby ResetTimer Delay: Delay where : Integer (1..480) Delay Set the delay in minutes. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 115: Systemunit Commands
NetworkServices Wifi Allowed xConfiguration NetworkServices Wifi Enabled Spark: xConfiguration Spark ServiceOverrides GdsBaseUrl xConfiguration Spark ServiceOverrides U2CBaseUrl xConfiguration Spark ServiceOverrides WdmBaseUrl Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 116: Xcommand Systemunit Firsttimewizard Stop
Clears the list of system notifications that are reported by xStatus SystemUnit Notifications xCommand SystemUnit OptionKey Remove Type: Type Text/Type. where Requires user role: ADMIN : RemoteMonitoring Type USAGE: xCommand SystemUnit Notifications RemoveAll Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 117: Xcommand Systemunit Optionkey Removeall
Banner text <enter> . <enter> Requires user role: ADMIN USAGE: xCommand SystemUnit SignInBanner Set Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 118: Time Commands
: Integer (0..23) Hour : String (0, 40) ConfigId The unique identifier for the configuration. : Integer (0..59) Minute : Integer (0..59) Second Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 119: Xcommand Userinterface Message Alert Display
: String (0, 255) FeedbackId xCommand UserInterface Message Alert Clear The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 120: Xcommand Userinterface Message Prompt Display
Enter the text to appear on the feedback options. : String (0, 255) Option.5 Enter the text to appear on the feedback options. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 121: Xcommand Userinterface Message Textline Display
Requires user role: ADMIN USAGE: xCommand UserInterface OSD Key Click Key: where : 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 122: Xcommand Userinterface Presentation Externalsource Add
The unique string that identifies this input source. It was defined when the source was created with the UserInterface Presentation ExternalSource Add command. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
Page 123: Xcommand Userinterface Presentation Externalsource State Set
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 : Yes Confirm Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 124: Xcommand Usermanagement Remotesupportuser Getstate
UserManagement User Passphrase Change NewPassphrase: "NewPassphrase" YourPassphrase OldPassphrase: "OldPassphrase" where : String (0, 255) NewPassphrase : String (0, 255) OldPassphrase Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 125: Video Commands
Connector status to find the connector IDs. USAGE: xCommand Video PresentationPIP Set Position: Position where : CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/ Position UpperRight Select one of the predefined positions. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 126: Xcommand Video Presentationview Set
: CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/ PIPPosition UpperRight Select the position for the self-view image. : First/Fourth/Second/Third OnMonitorRole Displays self-view on monitors with this role. Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 127: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 128: Description Of The Xstatus Commands
Call [n] FacilityServiceId ......................137 xStatus Capabilities Conference MaxAudioCalls ..................141 xStatus Call [n] HoldReason ........................137 xStatus Capabilities Conference MaxCalls ....................141 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 129 Diagnostics Message [n] Type ..................... 147 xStatus MediaChannels Call [n] Channel [n] Video ResolutionY ...............154 H323 status ............................148 Network status ........................... 154 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 130 SIP AlternateURI Primary [n] URI ....................166 xStatus Peripherals ConnectedDevice [n] Status..................160 xStatus SIP Authentication ........................166 xStatus Peripherals ConnectedDevice [n] Type ..................160 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 131 Video Output Connector [n] ConnectedDevice CEC Name ............179 xStatus SystemUnit Software Version .....................173 xStatus Video Output Connector [n] ConnectedDevice CEC PowerControl ...........179 xStatus SystemUnit State NumberOfActiveCalls ..................173 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 132 Video Selfview FullscreenMode ....................181 xStatus Video Selfview Mode ........................181 xStatus Video Selfview OnMonitorRole ....................181 xStatus Video Selfview PIPPosition ......................181 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 133: Audio Status
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: On/Off Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 134: Xstatus Audio Output Connectors Line [N] Delayms
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: 0..100 Example: xStatus Audio Volume *s Audio Volume: 70 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 135: Bookings Status
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus Call 27 CallbackNumber *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 136: Xstatus Call [N] Calltype
Call [n] DeviceType xStatus Call [n] Duration Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities.
Page 137: Xstatus Call [N] Placedonhold
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: Integer Example: xStatus Call 27 ReceiveCallRate *s Call 27 ReceiveCallRate: 4000 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 138: Xstatus Call [N] Remotenumber
Call 27 TransmitCallRate xStatus Cameras Camera 1 Flip *s Call 27 TransmitCallRate: 768 *s Camera 1 Flip: "Off" ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 139: Xstatus Cameras Camera [N] Hardwareid
Cameras Camera 1 Position Pan *s Camera 1 Manufacturer: "Cisco" *s Camera 1 Position Pan: 412 ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 140: Xstatus Cameras Camera [N] Position Tilt
Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: String Example: xStatus Cameras Camera 1 SerialNumber *s Camera 1 SerialNumber: "B1AB26B00010" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 141: Capabilities Status
Requires user role: ADMIN, USER 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 142: Conference Status
*s Conference Call 2 Capabilities FECC NumberOfSources: 5 xStatus Conference Call Capabilities FarendMessage Mode ** end *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 143: Xstatus Conference Call [N] Capabilities Fecc Source [N] Name
*s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 Capabilities FECC Source 1 SourceId: 6 ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 144: Xstatus Conference Call [N] Manufacturer
Value space of the result returned: String Example: xStatus Conference Call 2 SoftwareID *s Conference Call 2 SoftwareID: "CE8" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 145: Xstatus Conference Multipoint Mode
Value space of the result returned: *s Conference Presentation CallId: 0 On/Off ** end Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 146: Xstatus Conference Speakerlock Callid
Value space of the result returned: Error/Warning/Critical Example: xStatus Diagnostics Message 4 Level *s Diagnostics Message 4 Level: Warning ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 147: Xstatus Diagnostics Message [N] References
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 Example: xStatus Diagnostics Message Type *s Diagnostics Message 1 Type: CamerasDetected ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 148: H323 Status
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus H323 Gatekeeper Reason *s H323 Gatekeeper Reason: "" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 149: Xstatus H323 Mode Status
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus HttpFeedback 1 URL *s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 150: Mediachannels Status
*s MediaChannels Call 27 Channel 327 Audio Protocol: AACLD *s MediaChannels Call 27 Channel 327 Audio Mute: False ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 151: Xstatus Mediachannels Call [N] Channel [N] Direction
*s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost: 0 *s MediaChannels Call 27 Channel 327 NetStat Bytes: 496640 ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 152: Xstatus Mediachannels Call [N] Channel [N] Netstat Lastintervalreceived
Integer Example: xStatus MediaChannels Call 27 Channel 327 NetStat MaxJitter *s MediaChannels Call 27 Channel 327 NetStat MaxJitter: 2 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 153: Xstatus Mediachannels Call [N] Channel [N] Type
H261/H263/H263p/H263pp/H264/HEVC/JPEG/MP4V/Off Example: xStatus MediaChannels Call 27 Channel 327 Video Protocol *s MediaChannels Call 27 Channel 327 Video Protocol: H264 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 154: Xstatus Mediachannels Call [N] Channel [N] Video Resolutionx
Requires user role: ADMIN, USER 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 155: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 156: 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 157: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 158: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 159: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 160: Xstatus Peripherals Connecteddevice [N] Upgradestatus
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 161: Provisioning Status
Value space of the result returned: String Example: xStatus Provisioning Software Current URL *s Provisioning Software Current URL: "http://.../s52020ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 162: Xstatus Provisioning Software Current Versionid
*s Provisioning Software UpgradeStatus Message: "" xStatus Provisioning Software UpgradeStatus Status ** end *s Provisioning Software UpgradeStatus Status: None ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 163: Xstatus Provisioning Software Upgradestatus Url
** end String Example: xStatus Provisioning Software UpgradeStatus VersionId *s Provisioning Software UpgradeStatus VersionId: "s52010ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 164: Proximity Status
Deactivated: Proximity services have been deactivated with the command xCommand Proximity Services Deactivate. Requires user role: ADMIN, USER Example: xStatus Proximity Services Availability *s Proximity Services Availability: Disabled ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 165: Security Status
Requires user role: ADMIN, USER Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency InternalLogging *s Security Persistency InternalLogging: Persistent ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 166: Xstatus Security Persistency Localphonebook
Requires user role: ADMIN, USER Value space of the result returned: Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 167: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 168: Xstatus Sip Proxy [N] Status
Value space of the result returned: Digest/Off Example: xStatus SIP Registration 1 Authentication *s SIP Registration 1 Authentication: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 169: Xstatus Sip Registration [N] Uri
Shows whether or not the SSL certificate of the server that the video system / codec tries to register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or Requires user role: ADMIN, USER CUCM.
Page 170: Standby Status
SystemUnit Hardware Module CompatibilityLevel Shows whether the system is in standby mode or not. The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints running TC software are manufactured with a new version of the flash memory.
Page 171: Xstatus Systemunit Hardware Monitoring Fan [N] Status
*s SystemUnit ProductId: "Cisco TelePresence Codec SX80" String ** end Example: xStatus SystemUnit Notifications Notification 1 Text *s SystemUnit Notifications Notification 1 Text: "OK" ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 172: Xstatus Systemunit Productplatform
SystemUnit Software OptionKeys RemoteMonitoring *s SystemUnit Software DisplayName: "Display Name" *s SystemUnit Software OptionKeys RemoteMonitoring: "true" ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 173: Xstatus Systemunit State Numberofinprogresscalls
Example: xStatus SystemUnit State NumberOfActiveCalls xStatus SystemUnit Uptime *s SystemUnit State NumberOfActiveCalls: 0 *s SystemUnit Uptime: 597095 ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 174: Time Status
The value is an empty string until a value is set with the UserInterface Extensions Widget SetValue command. Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: String Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 175: Xstatus Userinterface Extensions Widget [N] Widgetid
Value space of the result returned: False/True/Unknown Example: xStatus Video Input Connector 1 Connected *s Video Input Connector 1 Connected: True ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 176: Xstatus Video Input Connector [N] Signalstate
*s Video Input Source 1 Resolution FormatStatus: Ok Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 177: Xstatus Video Input Source [N] Formattype
*s Video Layout LayoutFamily Local: "equal" xStatus Video Input Source 1 Resolution Height ** end *s Video Input Source 1 Resolution Height: 1080 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 178: Xstatus Video Layout Layoutfamily Remote
Video Output Connector 1 ConnectedDevice CEC DeviceType *s Video Monitors: Single *s Video Output Connector 1 ConnectedDevice CEC DeviceType: TV ** end ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 179: Xstatus Video Output Connector [N] Connecteddevice Cec Name
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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 180: Xstatus Video Output Connector [N] Connecteddevice Preferredformat
** end 176..4000 Example: xStatus Video Output Connector 1 Resolution Width *s Video Output Connector 1 Resolution Width: 1920 ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 181: Xstatus Video Output Connector [N] Type
Video Selfview PIPPosition *s Video Selfview PIPPosition: LowerRight Example: ** end xStatus Video Selfview FullscreenMode *s Video Selfview FullscreenMode: Off ** end Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 182: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 183: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 184: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 185 • 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 186: 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 CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 187: User Documentation On The Cisco Web Site
• Video conferencing room guidelines: Things to do to improve the perceived audio quality Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15333.07...
Page 188 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/go/offices...

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