Cisco TelePresence SX80 Reference Manual

Cisco TelePresence SX80 Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX80:
Table of Contents

Advertisement

Cisco TelePresence SX80
API Reference Guide
Introduction
About the API
xConfiguration
xCommand
xStatus
Appendices
Collaboration Endpoint Software 9.1
JUNE 2017
Application Programming Interface (API)
Reference Guide
Cisco TelePresence SX80
Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017.
1
Copyright © 2017 Cisco Systems, Inc. All rights reserved.
D15317.07

Advertisement

Table of Contents
loading

Summary of Contents for Cisco TelePresence SX80

  • Page 1 About the API xConfiguration xCommand xStatus Appendices Collaboration Endpoint Software 9.1 JUNE 2017 Application Programming Interface (API) Reference Guide Cisco TelePresence SX80 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 2: Table Of Contents

    User documentation on the Cisco web site ......220 Status ..................20 Events ................... 21 Feedback mechanism ............22 Feedback expressions ............22 Terminal connections ............23 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 3: Introduction

    Cisco TelePresence SX80 API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 4: We Recommend You Visit Our Web Site Regularly For Updated About This Guide

    For Spark registred systems, go to: • Cisco TelePresence SX80 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 systems (CUCM, VCS) as well as video systems registered Cisco web site appendix.
  • Page 5: Go To:Http://Www.cisco.com/Go/Sx-Docs What's New In Ce9.1

    The feature is based on ultrasound, and it does not keep record of who was in the room, only whether or not the room is in use. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 6 Peripherals Profile TouchPanels OLD: Default value: NotSet NEW: Default value: Minimum1 Video Input Connector [n] PresentationSelection OLD: Valuespace: AutoShare/Manual/OnConnect NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 7 User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, USER SystemUnit FactoryReset (All products) OLD: Keep: LocalSetup/Network/Spark/Provisioning NEW: Keep: LocalSetup/Network/Spark/Provisioning/SerialPort/Certificates (not in use) Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 8 / ConfigurationFile / DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus / PresenterTrack / H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey / IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 9: What's New In Ce9.0

    Unplugging the presentation cable instantly stops the to work: presentation sharing. xConfiguration Standby WakeupOnMotionDetection You can’t manually place the system in standby when this feature is enabled. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 10 Audio Input Line [n] * Video Output Connector [n] CEC Mode Audio Input Microphone [n] * Video Output Connector [n] MonitorRole Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 11 UserInterface Presentation ExternalSource State Set Cameras AutoFocus Diagnostics Stop UserManagement User Passphrase Change Cameras PresenterTrack ClearPosition Video Input SetMainVideoSource Cameras PresenterTrack Set Cameras PresenterTrack StorePosition Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 12 CallProtocolVcsProvisioningCompatibility, CameraId, CameraPairing, CameraSerial, Cameras Camera[n] Manufacturer CameraSoftwareVersion, CameraStatus, CamerasDetected, ConfigurationFile, DefaultCallProtocolRegistered, EthernetDuplexMatches, FanStatus, PresenterTrack, Cameras Camera[n] Model H320GatewayStatus, H323GatekeeperStatus, HasValidReleaseKey, IpCameraStatus, Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 13 Video Selfview FullscreenMode Peripherals ConnectedDevice[n] Type Video Selfview Mode Peripherals ConnectedDevice[n] UpgradeStatus Video Selfview OnMonitorRole Standby State Video Selfview PIPPosition SystemUnit State NumberOfActiveCalls Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 14: About The Api

    Cisco TelePresence SX80 API Reference Guide  Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 15: Api Fundamentals

    It can be disabled. You need a SSH of which method you choose, the structure of the API is You can connect a non-Cisco controller directly to an SX80 client, such as PuTTY, to access the API over SSH.
  • Page 16: Rs-232 / Serial Connection

    SerialPort LoginRequired: <Off/On> 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.
  • 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 29: Xconfiguration Commands

    Cisco TelePresence SX80 API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 30: Description Of The Xconfiguration Commands

    Audio Input Microphone [1..8] Level .................. 40 xConfiguration Cameras SpeakerTrack TrackingMode ................46 xConfiguration Audio Input Microphone [1..8] Mode ................. 40 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 31 H323 NAT Mode ........................54 xConfiguration Network [1] VLAN Voice Mode ..................64 xConfiguration H323 NAT Address ......................54 xConfiguration Network [1] VLAN Voice VlanId ..................64 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 32 Provisioning configuration ........................72 xConfiguration SIP Turn Server ........................79 xConfiguration Provisioning Connectivity ....................72 xConfiguration SIP Turn UserName ......................79 xConfiguration Provisioning Mode ......................72 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 33 UserManagement LDAP Server Address ................. 86 xConfiguration Video Selfview OnCall Duration ..................95 xConfiguration UserManagement LDAP Server Port ................86 xConfiguration UserManagement LDAP Encryption ................. 86 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 34: Audio Configuration

    When set to InCallOnly this will prevent the audio-system from being muted by mistake. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 35: Xconfiguration Audio Microphonereinforcement Gain

    Select a value between -24 and 0, in steps of 1 dB. : Sunrise/Mischief/Ripples/Reflections/Vibes/Delight/Evolve/Playful/Ascent/ RingTone Calculation/Mellow/Ringer Select a ringtone from the list. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 36: Xconfiguration Audio Input Hdmi [1

    Off: Audio is always played, locally and to far end; you do not have to present the HDMI input source. On: Audio is played, locally and to far end, only when you present the HDMI input source. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 37: Xconfiguration Audio Input Line [1

    Select a value between 0 and 24, in steps of 1 dB. : 1/2/3/4/5 VideoInputSource Select the video input connector to associate the audio source with. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 38: Xconfiguration Audio Input Line [1

    Once selected, echo cancellation is active at all times. Off: Turn off the dereverberation. On: Turn on the dereverberation. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 39: Xconfiguration Audio Input Microphone [1

    : Unique ID that identifies the microphone input. Range: 1..8 : 1/2/3/4/5 VideoInputSource Select the video input connector to associate the audio source with. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 40: Xconfiguration Audio Input Microphone [1..8] Level

    : Integer (-24..0) Level On: Enable the audio input microphone connector. Select a value between -24 and 0, in steps of 1 dB. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 41: Xconfiguration Audio Output Hdmi [1

    HDMI output. The actual delay is HDMI-delay + DelayMs. The Audio Output Connectors Line [n] DelayMs status reports the actual delay. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 42: Xconfiguration Audio Output Line [1

    On: Enable the equalizer for the audio output line. Off: Disable the audio line output. On: Enable the audio line output. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 43: Cameras Configuration

    Typical situations where the codec does not receive EDID information are: when you connect : Off/On DefaultMode a Cisco TelePresence 60 camera using 3G-SDI; when you connect a Cisco TelePresence 60 Off: Turn off the camera backlight compensation. (Cisco PrecisionHD 1080p4xS2) camera; when you use an HDMI repeater that does not pass on EDID information.
  • Page 44: Xconfiguration Cameras Camera [1

    Manual: In manual mode the gamma value is changed with the gamma level setting, ref. Cameras Camera [n] Gamma Level. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 45: Xconfiguration Cameras Camera [1..7] Gamma Level

    Off: Display the image as other people see you. On: Display the image as you see yourself in a mirror. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 46: Xconfiguration Cameras Preset Triggerautofocus

    Cameras SpeakerTrack TrackingMode xConfiguration Cameras SpeakerTrack Mode This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera, and when Cameras SpeakerTrack Mode is set to Auto. This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera.
  • Page 47: Xconfiguration Cameras Speakertrack Connectordetection Mode

    Cameras SpeakerTrack ConnectorDetection Mode xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected to This setting applies only when a Cisco TelePresence SpeakerTrack 60 camera is connected the codec (video system).
  • Page 48: Conference Configuration

    If multiple protocols are available, the order of priority is: 1) SIP; 2) H323; 3) H320. If the Requires user role: ADMIN system cannot register, the auto-selection chooses H323. Default value: Off H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link). USAGE: xConfiguration Conference AutoAnswer Mute: Mute H323: All calls are set up as H.323 calls.
  • Page 49: Xconfiguration Conference Defaultcall Rate

    On: Allows the far end to be able to select your video sources and control your local camera (pan, tilt, zoom). You will still be able to control your camera and select your video sources as normal. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 50: Xconfiguration Conference Maxreceivecallrate

    Requires user role: ADMIN Default value: 6000 USAGE: xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate where : Integer (64..6000) MaxTotalTransmitCallRate The maximum transmit call rate (kbps). Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 51: Xconfiguration Conference Multistream Mode

    OutputStandbyActive: The pin is activated when the system is in standby mode, and deacti¬vated when no longer in standby. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 52: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 53: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 54: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 55: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 56: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 57: 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 58: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 59: Xconfiguration Network [1] Ipv4 Subnetmask

    DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 60: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 61: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 62: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 63: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 64: Xconfiguration Network [1] Speed

    : Auto/Manual/Off Mode : Auto/10half/10full/100half/100full/1000full 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 65: Networkservices Configuration

    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 66: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 67: Xconfiguration Networkservices Ntp Server [1

    : 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 68: 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 69: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 70: 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 71: 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 72: 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 SX80 API Reference Guide CE9.1, JUNE 2017.
  • Page 73: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 74: 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 75: 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 76: Roomanalytics Configuration

    Default value: 115200 USAGE: xConfiguration SerialPort BaudRate: BaudRate where : 9600/19200/38400/57600/115200 BaudRate Set a baud rate from the baud rates listed (bps). Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 77: Xconfiguration Serialport Loginrequired

    Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Authentication Password: "Password" where : String (0, 128) Password A valid password. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 78: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 79: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 80: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 81: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 82: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 83: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 84: Userinterface Configuration

    Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, WET, Zulu DisplayName: Show the system's display name (refer to the SIP DisplayName setting). Select a time zone from the list. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 85: Xconfiguration Userinterface Keytones Mode

    : Arabic/Catalan/ChineseSimplified/ChineseTraditional/Czech/Danish/Dutch/English/ Language EnglishUK/Finnish/French/FrenchCanadian/German/Hebrew/Hungarian/Italian/Japanese/ Korean/Norwegian/Polish/Portuguese/PortugueseBrazilian/Russian/Spanish/SpanishLatin/ Swedish/Turkish Select a language from the list. Arabic and Hebrew are not supported in this software version. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 86: Usermanagement Configuration

    UserManagement LDAP Server Address: "Address" encryption. where : String (0, 255) Address A valid IPv4 address, IPv6 address or hostname. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 88: Xconfiguration Usermanagement Ldap Attribute

    : Unique ID that identifies the video input connector. Range: 1..5 : Connector 1, 2, 3, 4: Off/On Connector 5: Off Mode Off: Disable camera control. On: Enable camera control. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 89: Xconfiguration Video Input Connector [1

    AnalogYPbPr: Set to AnalogYPbPr to force the DVI video input to AnalogYPbPr, as the component (YPbPr) signal cannot be auto detected. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 90: Xconfiguration Video Input Connector [1

    (for example when a connected computer wakes up from sleep mode). Otherwise, the behavior is the same as in manual mode. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 91: Xconfiguration Video Input Connector [1

    First and Second. Monitors with monitor role Second are used first, then First. If a presentation is part of the layout, the presentation is shown on the monitor with monitor role Third. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 92: Xconfiguration Video Output Connector [1..2] Cec Mode

    Recorder: Show all participants, including the local main video (self-view). If active, also show the presentation. Monitors/outputs with this monitor role are disregarded by the Video Monitors setting. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 93: Xconfiguration Video Output Connector [1..3] Resolution

    On: The self-view picture will be shown in fullscreen. : 1/2/3/4 DefaultSource The video input source to use as default presentation source. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 94: Xconfiguration Video Selfview Default Onmonitorrole

    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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 95: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 96: Xcommand Commands

    Cisco TelePresence SX80 API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 97: Description Of The Xcommand Commands

    Call FarEndControl RoomPreset Activate ................115 xCommand Audio Sound Stop ......................... 110 xCommand Call FarEndControl Source Select ..................115 xCommand Audio SoundsAndAlerts Ringtone List ................. 110 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 98 Peripherals List ........................131 xCommand Cameras AutoFocus Diagnostics Stop .................123 xCommand Peripherals Pairing DeviceDiscovery Start ................131 xCommand Cameras PresenterTrack ClearPosition ................123 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 99 UserInterface Extensions Set ....................145 xCommand RoomPreset Clear .........................139 xCommand UserInterface Extensions Widget SetValue ................146 xCommand RoomPreset Store ........................140 xCommand UserInterface Extensions Widget UnsetValue ..............146 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 100 Video PresentationPIP Set ....................153 xCommand UserManagement RemoteSupportUser Create ..............150 xCommand Video PresentationView Set ....................153 xCommand UserManagement RemoteSupportUser Delete ..............150 xCommand Video Selfview Set ........................154 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 101: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 102: Xcommand Audio Localinput Add

    Line and HDMI inputs. : On/Off On: Adjusts the gain continuously to maintain a constant sound level (default). Off: No automatic gain control. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 103: Xcommand Audio Localinput Remove

    (1..8) for a microphone connector Select a connector. The connectors are numbered from left to right on the codec connector panel (as seen from rear). Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 104: Xcommand Audio Localinput Update

    Off: No automatic gain control. : On/Off Mute On: Mutes the mix of input signals. Off: No muting. : Integer (1..2) Channels Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 105: Xcommand Audio Localoutput Add

    On: The volume will change according to the level set with the volume controls on the user interface, or with the xCommand Audio Volume commands. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 106: Xcommand Audio Localoutput Connectinput

    The unique identifier of the local output. It was generated when the local output was created with the xCommand Audio LocalOutput Add command. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 107: Xcommand Audio Localoutput Removeconnector

    Audio Volume commands. Off: The volume is neither influenced by the volume controls on the user interface, nor the xCommand Audio Volume commands. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 108: Xcommand Audio Localoutput Updateinputgain

    -54 dB equals Off. xCommand Audio Microphones Mute Mute all microphones. Requires user role: INTEGRATOR, USER USAGE: xCommand Audio Microphones Mute Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 109: Xcommand Audio Remoteoutput Connectinput

    InputGain Set the gain on the input signal. The gain can also be negative (attenuation). The value -54 dB equals Off. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 110: Xcommand Audio Remoteoutput Updateinputgain

    Requires user role: ADMIN Requires user role: INTEGRATOR, USER USAGE: xCommand Audio Setup Clear USAGE: xCommand Audio SoundsAndAlerts Ringtone List Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 111: Xcommand Audio Soundsandalerts Ringtone Play

    : Integer (1..10) Steps xCommand Audio Volume ToggleMute Choose the number of steps to increase the volume with. One step is 0.5 dB. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 112: Xcommand Audio Volume Unmute

    Select a connector number. Together with the ConnectorType it uniquely identifies the Requires user role: ADMIN, USER connector. USAGE: : HDMI/Line/Microphone ConnectorType xCommand Audio VuMeter StopAll Select the connector type. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 113: Bookings Commands

    : String (0, 128) : Integer (0..65534) Offset The booking ID of a call or conference. Offset number of bookings for this search. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 114: Call Commands

    Call command to see the CallId. : Left/Right/Up/Down/ZoomIn/ZoomOut Value Select the action for how to move the camera. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 115: Xcommand Call Farendcontrol Camera Stop

    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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 116: Xcommand Call Farendmessage Tstringsend

    Call Join CallId: CallId where : Integer (0..65534) CallId You can have from 1 to 10 CallId parameters in the same command. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 117: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 118: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 119: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 120: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 121: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 122: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 123: Xcommand Camera Triggerautofocus

    Select which camera to diagnose. xCommand Cameras PresenterTrack ClearPosition This setting applies only when using a Cisco TelePresence SX80 with a Precision 60 camera or SpeakerTrack 60 camera. Clear the stored presenter tracking camera position for the overview image of the stage. The PresenterTrack feature will still work after the camera position has been cleared, but the camera will not view a predefined position upon activation.
  • Page 124: Xcommand Cameras Presentertrack Storeposition

    Cameras PresenterTrack StorePosition xCommand Cameras PresenterTrack Set This setting applies only when using a Cisco TelePresence SX80 with a Precision 60 camera or This setting applies only when using a Cisco TelePresence SX80 with a Precision 60 camera or SpeakerTrack 60 camera.
  • Page 125: Xcommand Cameras Speakertrack Activate

    Cameras SpeakerTrack Diagnostics Start Tracking: Tracking to Auto (default). where This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera. : On/Off Tracking The SpeakerTrack 60 camera assembly consists of two cameras and uses an audio tracking On: Displays diagnostics from both cameras simultaneously.
  • Page 126: Xcommand Cameras Speakertrack Whiteboard Activateposition

    : Integer (1..8) WhiteboardId You can give the position an id number. Currently the only id that can be used is 1. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 127: Conference Commands

    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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 128: Diagnostics Commands

    : Integer (1..999999999) Appearance Internal usage only. : String (0, 255) DisplayName The display name of the remote participant. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 129: Gpio Commands

    Deregister the feedback slot that was registered using the xCommand HttpFeedback Register command. : High/Low Pin2 : High/Low Pin3 : High/Low Pin4 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 130: 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 131: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 132: Xcommand Peripherals Pairing Unpair

    You can add several contact methods to a contact using the xCommand Phonebook where ContactMethod Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in : String (1, 100) MacAddress the API and on the web interface.
  • Page 133: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 134: 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 135: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 136: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 137: Presentation Commands

    Select which local presentation you wish to stop, identified by presentation instance. : Integer (1..4) PresentationSource Select which local presentation you wish to stop, identified by source number. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 138: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 139: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 140: Security Commands

    ConfirmAndReboot Reboots the system. xCommand Security Session List List active sessions. Requires user role: ADMIN, USER USAGE: xCommand Security Session List Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 141: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 142: Systemunit Commands

    NetworkServices Wifi Allowed xConfiguration NetworkServices Wifi Enabled Spark: xConfiguration Spark ServiceOverrides GdsBaseUrl xConfiguration Spark ServiceOverrides U2CBaseUrl xConfiguration Spark ServiceOverrides WdmBaseUrl Provisioning: Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 143: Xcommand Systemunit Firsttimewizard Stop

    Text/Type. USAGE: xCommand SystemUnit OptionKey Remove Type: Type Requires user role: ADMIN where USAGE: : Encryption/MultiSite/RemoteMonitoring Type xCommand SystemUnit Notifications RemoveAll Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 144: Xcommand Systemunit Optionkey Removeall

    Banner text <enter> . <enter> Requires user role: ADMIN USAGE: xCommand SystemUnit SignInBanner Set Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 145: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 146: Xcommand Userinterface Extensions Widget Setvalue

    : 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 147: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 148: Xcommand Userinterface Message Textline Display

    Returns the current list of external input sources. Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL USAGE: xCommand UserInterface Presentation ExternalSource List Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 149: Xcommand Userinterface Presentation Externalsource Remove

    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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 150: Xcommand Usermanagement Remotesupportuser Disablepermanently

    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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 151: Xcommand Usermanagement User Passphrase Set

    The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API command to find the ID: xStatus Video Input Source. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 152: Xcommand Video Input Source Setactiveconnector

    : Integer (1..3) Output Choose the output you want to reset. : String (1, 128) CustomLayoutName Enter a name for the layout. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 153: Xcommand Video Matrix Swap

    The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API command to find the ID: xStatus Video Input Source. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 154: Xcommand Video Selfview 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 155: Xstatus Commands

    Cisco TelePresence SX80 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 156: Description Of The Xstatus Commands

    Bookings status ..........................165 xStatus Cameras Camera [n] MacAddress ....................169 xStatus Bookings Current Id ........................165 xStatus Cameras Camera [n] Manufacturer .....................169 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 157 Conference Call [n] Capabilities IxChannel Status ..............175 xStatus HttpFeedback [1..4] URL ......................181 xStatus Conference Call [n] Capabilities Presentation ................175 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 158 Provisioning Software UpgradeStatus Message ................194 xStatus Network 1 CDP VoIPApplianceVlanID ..................188 xStatus Provisioning Software UpgradeStatus Phase ................194 xStatus Network 1 CDP VTPMgmtDomain ..................... 188 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 159 SIP Registration [n] Status ......................200 xStatus UserInterface ContactInfo Name ....................207 xStatus SIP Registration [n] URI ........................201 xStatus UserInterface Extensions Widget [n] Value .................207 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 160 Video Output Connector [n] Connected ..................211 xStatus Video Output Connector [n] ConnectedDevice CEC DeviceType ..........211 xStatus Video Output Connector [n] ConnectedDevice CEC Name ............211 Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 161 Value space of the result returned: Microphone.1/../Microphone.4/Line.1/Line.2/HDMI.2 Example: xStatus Audio Input LocalInput 1 Connector *s Audio Input LocalInput 1 Connector: "Microphone.1" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 162 ** end Value space of the result returned: On/Off Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 163 Value space of the result returned: 1..2 Example: xStatus Audio Output LocalOutput 4 Channels *s Audio Output LocalOutput 4 Channels: "1" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 164 *s Audio Output RemoteOutput 9 CallId: 28 Example: ** end xStatus Audio Output LocalOutput 4 Name *s Audio Output LocalOutput 4 Name: "MyLocalOutput1" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 165 Requires user role: ADMIN, USER Value space of the result returned: Off/On Example: xStatus Audio VolumeMute *s Audio VolumeMute: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 166: Call Status

    *s Call 5 AnswerState: Answered ** end xStatus Call [n] DeviceType Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints xStatus Call [n] AttendedTransferFrom (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities.
  • Page 167 Value space of the result returned: None/Aes-128 Example: xStatus Call 27 Encryption Type *s Call 27 Encryption Type: "None" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 168 Call 27 ReceiveCallRate xStatus Call 27 TransmitCallRate *s Call 27 ReceiveCallRate: 4000 *s Call 27 TransmitCallRate: 768 ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 169 Auto/On/Off *s Camera 1 Manufacturer: "Cisco" Example: ** end xStatus Cameras Camera 1 Flip *s Camera 1 Flip: "Off" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 170 Cameras Camera 1 Position Pan xStatus Cameras Camera 1 SerialNumber *s Camera 1 Position Pan: 412 *s Camera 1 SerialNumber: "B1AB26B00010" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 171 Cameras SpeakerTrack Availability xStatus Cameras PresenterTrack PresenterDetected *s Cameras SpeakerTrack Availability: Unavailable *s Cameras PresenterTrack PresenterDetected: False ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 172 Cameras SpeakerTrack Status 0..5 *s Cameras SpeakerTrack Status: Active Example: ** end xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 173 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 174 *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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 175 Conference Call 2 SoftwareID *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 SoftwareID: "CE8" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 176 Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: Integer Example: xStatus Conference Presentation CallId *s Conference Presentation CallId: 0 ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 177 Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: Off/Sending/Receiving Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 178 Value space of the result returned: Error/Warning/Critical Example: xStatus Diagnostics Message 4 Level *s Diagnostics Message 4 Level: Warning ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 179 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 180: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 181 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 182 *s MediaChannels Call 27 Channel 327 Audio Protocol: AACLD *s MediaChannels Call 27 Channel 327 Audio Mute: False ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 183 *s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost: 0 *s MediaChannels Call 27 Channel 327 NetStat Bytes: 496640 ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 184 Integer Example: xStatus MediaChannels Call 27 Channel 327 NetStat MaxJitter *s MediaChannels Call 27 Channel 327 NetStat MaxJitter: 2 ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 185 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 186 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 187 Network CDP PortID xStatus Network CDP SysObjectID *s Network 1 CDP PortID: "GigabitEthernet1/0/23" *s Network 1 CDP SysObjectID: "" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 188 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 189 Network 1 IPv6 Gateway *s Network 1 IPv4 Gateway: "192.0.2.10" *s Network 1 IPv6 Gateway: "" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 190 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 191 Value space of the result returned: String Example: xStatus Peripherals ConnectedDevice 1007 Name *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 192 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 193 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 194 *s Provisioning Software UpgradeStatus Message: "" xStatus Provisioning Software UpgradeStatus Status ** end *s Provisioning Software UpgradeStatus Status: None ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 195 ** end String Example: xStatus Provisioning Software UpgradeStatus VersionId *s Provisioning Software UpgradeStatus VersionId: "s52010ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 196 Example: xStatus RoomAnalytics PeoplePresence xStatus Proximity Services Availability *s RoomAnalytics PeoplePresence: No *s Proximity Services Availability: Disabled ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 197 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 198 Requires user role: ADMIN, USER Value space of the result returned: Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 199 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 200 Value space of the result returned: Digest/Off Example: xStatus SIP Registration 1 Authentication *s SIP Registration 1 Authentication: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 201 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 202 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 203 *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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 204 SystemUnit Software OptionKeys MultiSite *s SystemUnit Software DisplayName: "Display Name" *s SystemUnit Software OptionKeys MultiSite: "true" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 205 SystemUnit State NumberOfSuspendedCalls xStatus SystemUnit Software Version *s SystemUnit State NumberOfSuspendedCalls: 0 *s SystemUnit Software Version: "CE8.0.0" ** end ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 206 Value space of the result returned: xStatus SystemUnit Uptime String *s SystemUnit Uptime: 597095 Example: ** end xStatus Time SystemTime *s Time SystemTime: "2014-04-25T10:04:03Z" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 207 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 208 Value space of the result returned: Composite/DVI/HDMI/Unknown/YC Example: xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 209 *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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 210 Value space of the result returned: String Example: xStatus Video Layout LayoutFamily Local *s Video Layout LayoutFamily Local: "equal" ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 211 ** end Example: xStatus Video Output Connector 1 ConnectedDevice CEC DeviceType *s Video Output Connector 1 ConnectedDevice CEC DeviceType: TV ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 212 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 213 *s Video Output Connector 1 Resolution Width: 1920 Example: ** end xStatus Video Selfview FullscreenMode *s Video Selfview FullscreenMode: Off ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 214 Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight Example: xStatus Video Selfview PIPPosition *s Video Selfview PIPPosition: LowerRight ** end Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 215: Appendices

    Cisco TelePresence SX80 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 216: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 217: The Systemtools Commands

    Max failed login attempts [0]? systemtools ntp • Number of failed logins until a user is set inactive. Shows the NTP status. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 218 • Maximum consecutive equal digits in PINs. Minimum number of digits in PINs [0]? • Minimum number of digits in PINs. Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 219: 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 SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 220: User Documentation On The Cisco Web Site

    API reference guides: Reference guide for the Application Programmer Interface (API) Reference Guides > Technical References • CAD drawings: 2D CAD drawings with measurements Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15317.07...
  • Page 221 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...

Table of Contents