Commands ................20 The SystemTools commands ..........191 Configurations ...............20 About disconnect cause types ........... 193 Status ..................20 User documentation on the Cisco web site ......194 Events ................... 21 Feedback mechanism ............22 Feedback expressions ............22 Terminal connections ............23 SX20 Codec API Reference Guide CE9.1, JUNE 2017.
For Spark registred systems, go to: following product: https://support.ciscospark.com • Cisco TelePresence SX20 Codec Guidelines for how to find the documentation on the Cisco web site are included in the User documentation on the Cisco web site appendix. The guide describes the API for on-premise registered video systems (CUCM, VCS) as well as video systems registered to Cisco’s cloud service (Cisco Spark).
Cisco Spark registered systems xConfiguration SerialPort LoginRequired: <Off/On> 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.
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”...
JSON format. You can subscribe to changes on multiple Cisco TelePresence Management Suite (TMS) is used as TMS codec from which the notification originated. This means that parts of the API by register up to 15 different feedback uses this feedback slot to register its expressions.
Appendices Dos and don’ts Here are some best practices when programming the Cisco SX series API. AVOID remote control emulation The use of xCommand UserInterface OSD Key Click and discouraged. The commands are still available in the API, but backwards compatibility in your integrations.
The number of minutes (maximum 1440 minutes = 24 hours) before the Do Not Disturb system cannot register, the auto-selection chooses H323. session times out automatically. H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link). H323: All calls are set up as H.323 calls.
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...
: 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.
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.
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.
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.
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.
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). SX20 Codec API Reference Guide CE9.1, JUNE 2017.
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 alter- several management services reside on the same server, i.e.
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:...
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.
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, on the web interface and when using the remote control.
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"...
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.
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.
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.
Release Notes • Administering CE Endpoints on CUCM: Tasks to • Software release notes perform to start using the product with the Cisco Unified Communications Manager (CUCM) Maintain and Operate > End-User Guides • User guides: How to use the product •...
Page 195
Tandberg ASA. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.
Need help?
Do you have a question about the TelePresence SX20 Codec and is the answer not in the manual?
Questions and answers