Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Collaboration Endpoint Software 9.2
NOVEMBER 2017
API Reference Guide
Application Programming Interface (API)
Reference Guide
Cisco TelePresence DX70 and DX80
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 1
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
The top menu bar and the entries in the table of contents are
all hyperlinks, just click on them to go to the topic.
We recommend you visit our web site regularly for updated
versions of the user documentation.
Go to: http://www.cisco.com/go/dx-docs
Table of ContentsWhat’s in this guide?
Introduction ........................................................................... 3
About this guide
Software migration to CE software ...................................... 4
Downloading the user documentation ................................. 4
What’s new in CE9.2
What’s new in CE9.1
What’s new in CE9.0
About the API
API fundamentals
Connecting to the API ........................................................22
Password ............................................................................22
SSH ....................................................................................22
Tel n et ..................................................................................22
HTTP/HTTPS ......................................................................22
Serial connection over micro USB .....................................23
User roles ...........................................................................23
API output
The output modes ..............................................................24
Using the command line
API commands ...................................................................25
Other commands................................................................25
Command line shortcuts ....................................................26
Searching ...........................................................................26
Value types and formats.....................................................26
Commands
Configurations
.................................................................................... 27
Status
Multiline commands
Synchronous API calls
...................................................................................30
Events
...................................................................... 4
............................................................... 5
............................................................. 12
............................................................. 16
...................................................................... 21
.................................................................. 22
.............................................................................24
....................................................... 25
............................................................................27
....................................................................... 27
.............................................................. 28
..........................................................29
API Reference Guide
Feedback mechanism
Feedback expressions ....................................................... 31
Terminal connections ......................................................... 32
HTTP XMLAPI Authentication .............................................33
HTTP XMLAPI Session Authentication ...............................33
Getting status and configurations ...................................... 34
Sending commands and configurations .............................34
Using HTTP POST .............................................................. 34
Feedback from codec over HTTP
Registering for feedback ....................................................35
Translating from terminal mode to XML .............................36
Dos and don’ts
xConfiguration commands
Description of the xConfiguration commands
xCommand commands
Description of the xCommand commands
xStatus commands
Description of the xStatus commands
Appendices
About startup scripts
The SystemTools commands
About disconnect cause types
User documentation on the Cisco web site
....................................................................... 19 6
........................................................... 31
.........................................35
...................................................................... 37
.................................................. 38
......................39
....................................................... 90
........................... 91
........................................................... 140
................................ 141
.......................................................... 197
.............................................. 198
...........................................200
........................201
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 2
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Chapter 1
Introduction
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 3
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
About this guide
This guide introduces you to the Application Programmer
Interface (API) for the Collaboration Endpoint software, and
serves as a reference guide for the command line commands
for the following product:
• Cisco TelePresence DX70 and DX80
The guide describes the API for on-premise registered video
systems (CUCM, VCS) as well as video systems registered
to Cisco’s cloud service (Cisco Spark). For Cisco Spark
registered systems only a subset of the API is available, and
the user role (integrator and roomcontrol) of the local user
determines which commands are available.
Software migration to CE software
From Cisco Collaboration Endpoint software version 8.2
(CE8.2) all DX80 and DX70 units can run CE software, which
is the same software that runs on the Cisco TelePresence SX,
MX and Room Kit Series.
Cisco DX80 and Cisco DX70 were originally shipped with
Android based software. Before migrating to CE software, it is
important to carefully consider the conversion requirements
and the functionality changes compared to Android
based software; otherwise migration can leave you with a
non-functional deployment that requires you to convert back.
Refer to the software release notes, and the Administrator
Guide for further details.
API Reference Guide
Downloading the user documentation
You can download the user documentation from the Cisco
web site, go to:http://www.cisco.com/go/dx-docs
For Spark registred systems, go to:
https://support.ciscospark.com
Guidelines for how to find the documentation on the Cisco
web site are included in theUser documentation on the
Cisco web site appendix.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 4
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
What’s new in CE9.2
This section provides an overview of the new and
changed system settings, and the new features and
improvements in the Cisco Collaboration Endpoint
software version 9.2 (CE9.2) compared to CE9.1.
For more details, we recommend reading the Software
release notes:
http://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/
products-release-notes-list.html
New features and improvements
Macro framework
The macro framework allows users and integrators to write
JavaScript macros in order to automate scenarios and
customize endpoint behavior so that it suites an individual
customer’s requirements.
The combination of macros and powerful features such as
listening for events/status changes, automating execution of
commands and configurations, and providing local control
functionality for the In-Room control feature, provides many
possibilities for custom setups.
Minor behavioral changes, such as having the video system
in Do Not Disturb for an infinite amount of time, can be
easily realized by macros. Some other examples are: Reset
configurations automatically, make a call at a certain time
of the day, and issue alert or help messages depending on
status changes.
The macro editor, which also provides several example
macros, is available from the video system’s web interface.
Branding and halfwake customization
You can upload your own text and images to customize the
appearance of the screen in both the halfwake state and the
awake state.
In the Halfwake state you can:
• Add a background brand image to the screen.
• Add a small logo in the bottom right corner of the screen.
In the Awake state you can:
• Add a small logo in the bottom right corner of the screen.
• Add a label or message in the bottom left corner of the
screen.
HTTP Proxy support
You can set up the video system to go through a HTTP Proxy
when registering it to Cisco’s cloud service, Cisco Spark.
User interface features
• The Settings panel is restructured.
• The Settings panel in the user interface can be protected
by the video system’s admin password. If the password is
blank, anyone can access the Settings and factory reset
the system.
• If you select the Russian language on the user interface,
you can choose between a Russian keyboard and a
keyboard with a Latin character set.
• Arabic and Hebrew languages are added to the user
interface. Also localized keyboards are included.
• Basic IEEE 802.1x settings are added to the Settings
panel in the user interface.
Mute and unmute remote participants in a CMS hosted
conference (Active Control)
When a video system is enabled for Active Control in a CMS
(2.1 or later) conference you can mute and unmute remote
participants from the participant list on the user interface (the
feature must also be enabled on the CMS).
A video system that is running software version CE9.2 will
not be unmuted directly. When you try to unmute such a
video system remotely, a message will show up on its screen
requesting the user to unmute the audio locally.
API commands for Custom input prompt
API commands are introduced to allow for an input prompt
in the user interface:
TextInput *
with your custom text, a text input field for the user, and a
submit button, shows up on the user interface. For example,
you can prompt a user to leave feedback after an ended call.
You can specify what type of input you want from the user:
single line text, numeric, password, or PIN code.
The prompt can only be enabled via the API, so it is recommended to combine it with macros and either a custom user
interface panel or an auto-triggered event.
. When issuing the display command a prompt
xCommand UserInterface Message
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 5
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
Certificate upload via API
ASCII PEM formatted certificates can be installed directly
using multiline API commands (
Ceritifcates CA Add
Services Add
system from its web interface, as before.
API commands for user management
You can create and manage user accounts directly using API
commands (
you can also do this from the video system’s user interface.
Preview mode for In-Room Controls
The In-Room Control editor has a new preview mode. A
virtual touch interface shows how the design looks on the
user interface. The user interface is interactive so that you
can test the functionality. It produces real events on the video
system, which can trigger any functionality you have created
with a third-party control system or with a macro. A console
in the right pane displays both the widget values when interacted with, and control system feedback messages.
Intelligent Proximity changes
A Proximity indicator is displayed on the screen (middle right)
to inform that one or more clients are paired to the system
with Cisco Proximity. The old indicator (top left), which
was always shown when Proximity was enabled, has been
removed.
You can no longer disable the Proximity services from the
user interface.
The ultrasound settings have moved from Peripherals Pairing
Ultrasound to Audio Ultrasound.
xCommand UserManagement User *
, or
). You can also upload certificates to a video
xCommand Security
xCommand Security Ceritifcates
). As before,
Automatic factory reset when changing the call service
(device activation)
The video system will automatically factory reset and restart
when using the user interface to change the device activation method, for example from VCS to Cisco UCM. This will
prevent conflicting configurations when provisioning the video
system to a new service.
Changing the provisioning from the API will not automatically
factory reset the video system.
Support for separate RTP port ranges for audio and other
media
You can configure the video system so that audio uses a
different RTP port range than other media. The two ranges
cannot overlap. As default, all media use the same RTP port
range.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 6
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
Configuration changes in CE9.2
New configurations
Audio Ultrasound MaxVolume
Macros AutoStart
Macros Mode
NetworkServices HTTP Proxy Allowed
NetworkServices HTTP Proxy LoginName
NetworkServices HTTP Proxy Mode
NetworkServices HTTP Proxy Password
NetworkServices HTTP Proxy Url
Standby WakeupOnMotionDetection
UserInterface CustomMessage
UserInterface OSD HalfwakeMessage
UserInterface SettingsMenu Mode
API Reference Guide
Configurations that are removed
Conference MultiStream Mode
Configurations that are modified
Audio Input MicrophoneMode
OLD: User role: ADMIN
NEW: User role: ADMIN, INTEGRATOR
UserInterface Language
NEW: Arabic and Hebrew added to valuespace
Video Output Connector[1] Resolution
OLD: User role: ADMIN, INTEGRATOR
NEW: User role: ADMIN, INTEGRATOR, USER
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 7
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
Command changes in CE9.2
New commands
Macros Log Clear
Macros Log Get
Macros Macro Activate
Macros Macro Deactivate
Macros Macro Get
Macros Macro Remove
Macros Macro Rename
Macros Macro Roles Set
Macros Macro Save
Macros Runtime Restart
Macros Runtime Start
Macros Runtime Status
Macros Runtime Stop
Message Send
Security Certificates CA Add
Security Certificates CA Delete
Security Certificates CA Show
Security Certificates Services Activate
Security Certificates Services Add
Security Certificates Services Deactivate
Security Certificates Services Delete
Security Certificates Services Show
Standby Halfwake
UserInterface Branding Delete
UserInterface Branding Get
UserInterface Branding Updated
UserInterface Branding Upload
UserInterface Extensions Widget Action
UserInterface Message TextInput Clear
UserInterface Message TextInput Display
UserManagement User Add
UserManagement User Delete
UserManagement User Get
UserManagement User List
UserManagement User Modify
Commands that are removed
None
Commands that are modified
Audio Microphones Mute
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 8
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
Audio Microphones ToggleMute
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Audio Microphones Unmute
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Audio Sound Play
OLD: Sound: Alert / Bump / Busy / CallDisconnect / CallInitiate / CallWaiting / Dial / KeyInput
/ KeyInputDelete / KeyTone / Nav / NavBack / Notification / OK / PresentationConnect /
Ringing / SignIn / SpecialInfo / TelephoneCall / VideoCall / VolumeAdjust / WakeUp
NEW: Sound: Alert / Bump / Busy / CallDisconnect / CallInitiate / CallWaiting / Dial
/ KeyInput / KeyInputDelete / KeyTone / Nav / NavBack / Notification / OK / Pairing
/ PresentationConnect / Ringing / SignIn / SpecialInfo / TelephoneCall / VideoCall /
VolumeAdjust / WakeUp
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Audio Sound Stop
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Audio SoundsAndAlerts Ringtone List
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Audio SoundsAndAlerts Ringtone Play
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Call Disconnect
OLD: User role: ADMIN, USER
NEW: User role: ADMIN, INTEGRATOR, USER
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 9
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
Dial
OLD: User role: ADMIN, USER
NEW: User role: ADMIN, INTEGRATOR, USER
Peripherals HeartBeat
OLD: User role: ADMIN, ROOMCONTROL, USER
NEW: User role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
SystemUnit Boot
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
SystemUnit FirstTimeWizard Stop
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
UserInterface Extensions List
OLD: User role: INTEGRATOR, ROOMCONTROL, USER
NEW: User role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
UserInterface Message Prompt Display
Added: Duration: Integer(0..3600)
Video Input SetMainVideoSource
Added: Layout: Equal / PIP
OLD: User role: INTEGRATOR, USER
NEW: User role: ADMIN, INTEGRATOR, USER
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 10
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
Status changes in CE9.2
New statuses
Video Output Connector[n] ConnectedDevice CEC[n] LogicalAddress
Video Output Connector[n] ConnectedDevice ScreenSize
Statuses that are removed
None
Statuses that are modified
Diagnostics Message[n] Type
Removed from valuespace: CamerasDetectedNoIr / UdpPortRangeViolation
Added to valuespace: CameraDetected / CertificateExpiry / MacrosRuntimeStatus /
MediaPortRangeNegative / MediaPortRangeOdd / MediaPortRangeOverlap /
MediaPortRangeTooSmall / MediaPortRangeValueSpace / MicrophonesConnected
/ SparkActivationRequired / VideoPortRangeNegative / VideoPortRangeOdd /
VideoPortRangeTooSmall / VideoPortRangeValueSpace / UltrasoundConfigSettings
Video Input MainVideoSource
OLD: Value space: Integer
NEW: Value space: 1 / 2 / 3 / 4 / Composed
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 11
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
What’s new in CE9.1
This section provides an overview of the new and changed
system settings, and the new features and improvements
in the Cisco Collaboration Endpoint software version 9.1
(CE9.1) compared to CE9.0.
For more details, we recommend reading the Software
release notes:
http://www.cisco.com/c/en/us/support/collaborationendpoints/dx70/model.html#ReleaseNotes
http://www.cisco.com/c/en/us/support/collaborationendpoints/dx80/model.html#ReleaseNotes
New features and improvements
New wake-up experience
The new wake-up experience introduces a Halfwake state,
which leads to a calmer wake-up of the system, and gives
users better guidance on how to get started.
When wake-up on motion detection is enabled the system
will automatically wake to the Halfwake state when people
enter the room (DX80 only). It will also wake to this state
when a user pairs a Cisco Proximity client to the system (both
DX70 and DX80).
Bluetooth headset support
A Bluetooth headset can be used with the video system. The
headset must support HFP (Hands Free Protocol). The user
can enable Bluetooth and set the video system in Bluetooth
pairing mode from the user interface.
Support for the EAP authentication framework for wireless
networks
In addition to WPA-PSK and WPA2-PSK, the video system
now supports the WPA-EAP authentication framework
for Wi-Fi connections. In total the following methods are
supported:
• Open
• WPA-PSK (AES)
• WPA2-PS K (A ES)
• E A P -T LS
• E A P -T T L S
• EA P-FA ST
• PEAP
• EAP-MSCHAPv2
• EAP-GTC
Network port 2 can be disabled
You can connect a computer to the network through the
video system’s second network port. Then you only need one
network wall socket to support both the video system and the
computer.
For security reasons, we recommend that you disable
this network port if the video system is used in a public
environment. This way, you prevent someone from
connecting a computer to your network through the video
system.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 12
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
System configuration changes in CE9.1
New configurations
NetworkPort [2] Mode
Configurations that are removed
None.
Configurations that are modified
Network[ 1] IEEE8021X Password
OLD: Valuespace: String(0, 32)
NEW: Valuespace: String(0, 50)
Video Input Connector [n] PresentationSelection
OLD: Valuespace: AutoShare/Desktop/Hidden/Manual/OnConnect
NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 13
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
System command changes in CE9.1
New commands
SystemUnit FirstTimeWizard Stop
UserInterface Extensions Set
Commands that are removed
None.
Commands that are modified
Audio Select
OLD: Device: Internal/HeadsetUSB/HeadsetAnalog/HandsetUSB
NEW: Device: Internal/HeadsetBluetooth/HeadsetUSB/HeadsetAnalog/HandsetUSB
Audio Volume Decrease
OLD: Device: Internal/HeadsetUSB/HeadsetAnalog/HandsetUSB
NEW: Device: Internal/HeadsetBluetooth/HeadsetUSB/HeadsetAnalog/HandsetUSB
Audio Volume Increase
OLD: Device: Internal/HeadsetUSB/HeadsetAnalog/HandsetUSB
NEW: Device: Internal/HeadsetBluetooth/HeadsetUSB/HeadsetAnalog/HandsetUSB
Audio Volume Set
OLD: Device: Internal/HeadsetUSB/HeadsetAnalog/HandsetUSB
NEW: Device: Internal/HeadsetBluetooth/HeadsetUSB/HeadsetAnalog/HandsetUSB
Audio Volume SetToDefault
OLD: Device: Internal/HeadsetUSB/HeadsetAnalog/HandsetUSB
NEW: Device: Internal/HeadsetBluetooth/HeadsetUSB/HeadsetAnalog/HandsetUSB
Dial
OLD: CallRate: Integer (64..6000)
NEW: CallRate: Integer (64..3072)
SystemUnit FactoryReset (All products)
OLD: Keep: LocalSetup/Network/Spark/Provisioning
NEW: Keep: LocalSetup/Network/Spark/Provisioning/SerialPort/Certificates (not in use)
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 14
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
System status changes in CE9.1
New statuses
Audio Devices Bluetooth ActiveProfile
Audio VolumeHeadsetBluetooth
SystemUnit Software OptionKeys Encryption
Statuses that are removed
None
Statuses that are modified
Diagnostics Message Type
OLD: Value space: CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile
/ CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility / CallPr
otocolVcsProvisioningCompatibility / CameraId / CameraPairing / CameraSerial /
CameraSoftwareVersion / CameraStatus / CamerasDetected / ConfigurationFile /
DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus / PresenterTrack
/ H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey /
IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu / ISDNLinkCompatibility
/ ISDNLinkIpStack / ITLinstallation / InvalidSIPTransportConfig / LockDown /
RoomControl / MediaBlockingDetected / NetLinkStatus / NetSpeedAutoNegotiated
/ NetworkQuality / NTPStatus / OSDVideoOutput / OutputConnectorLocations
/ ProvisioningDeveloperOptions / ProvisioningStatus / SIPEncryption /
SIPListenPortAndOutboundMode / SIPProfileRegistration / SIPProfileType / SelectedV
ideoInputSourceConnected / SipIceAndAnatConflict / SIPListenPortAndRegistration /
TCPMediaFallback / TemperatureCheck / TLSVerifyRequiredCerts / TouchPanelConnection
/ ControlSystemConnection / TurnBandwidth / UdpPortRangeViolation /
UltrasoundSpeakerAvailability / ValidPasswords / VideoFromInternalCamera /
VideoInputStability / VideoInputSignalQuality / SparkConnectivity / SpeakerTrackFrontPa
nelMountedCorrectly / SpeakerTrackMicrophoneConnection / SpeakerTrackVideoInputs /
SpeakerTrackEthernetConnection / ANATOnVCS / ECReferenceDelay / AudioECRefDelay
/ AudioPairingNoise / AudioPairingRate / AudioPairingSNR / AudioPairingInterference /
AudioPairingTokenDecode / AudioInternalSpeakerDisabled / AbnormalCallTermination /
HasActiveCallProtocol / SipOrH323ButNotBothEnabled / PresentationSourceSelection /
SoftwareUpgrade / PlatformSanity / ContactInfoMismatch / MicrophoneReinforcement /
FirstTimeWizardNotCompleted / CaptivePortalDetected / MonitorDelay
NEW: Value space: : CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile
/ CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility / CallPr
otocolVcsProvisioningCompatibility / CameraId / CameraPairing / CameraSerial /
CameraSoftwareVersion / CameraStatus / CamerasDetected / CamerasDetectedNoIr /
ConfigurationFile / DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus
/ PresenterTrack / H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey /
IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu / ISDNLinkCompatibility
/ ISDNLinkIpStack / ITLinstallation / InvalidSIPTransportConfig / LockDown /
RoomControl / MediaBlockingDetected / NetLinkStatus / NetSpeedAutoNegotiated
/ NetworkQuality / NTPStatus / OSDVideoOutput / OutputConnectorLocations
/ ProvisioningDeveloperOptions / ProvisioningStatus / SIPEncryption /
SIPListenPortAndOutboundMode / SIPProfileRegistration / SIPProfileType / SelectedV
ideoInputSourceConnected / SipIceAndAnatConflict / SIPListenPortAndRegistration /
TCPMediaFallback / TemperatureCheck / TLSVerifyRequiredCerts / TouchPanelConnection
/ ControlSystemConnection / TurnBandwidth / UdpPortRangeViolation /
UltrasoundSpeakerAvailability / ValidPasswords / VideoFromInternalCamera /
VideoInputStability / VideoInputSignalQuality / SparkConnectivity / SpeakerTrackFrontPa
nelMountedCorrectly / SpeakerTrackMicrophoneConnection / SpeakerTrackVideoInputs /
SpeakerTrackEthernetConnection / ANATOnVCS / ECReferenceDelay / AudioECRefDelay
/ AudioPairingNoise / AudioPairingRate / AudioPairingSNR / AudioPairingInterference /
AudioPairingTokenDecode / AudioInternalSpeakerDisabled / AbnormalCallTermination /
HasActiveCallProtocol / SipOrH323ButNotBothEnabled / PresentationSourceSelection /
SoftwareUpgrade / PlatformSanity / ContactInfoMismatch / MicrophoneReinforcement /
FirstTimeWizardNotCompleted / CaptivePortalDetected / MonitorDelay / WifiCARequired
Standby State
OLD: Value space: Standby/EnteringStandby/Off
NEW: Value space: Standby/EnteringStandby/Halfwake/Off
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 15
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
What’s new in CE9.0
This section provides an overview of the new and changed
system settings, and the new features and improvements
in the Cisco Collaboration Endpoint software version 9.0
(CE9.0) compared to CE8.3.
For more details, we recommend reading the Software
release notes:
http://www.cisco.com/c/en/us/support/collaborationendpoints/dx70/model.html#ReleaseNotes
http://www.cisco.com/c/en/us/support/collaborationendpoints/dx80/model.html#ReleaseNotes
New features and improvements
Updated user interface
The user interfaces on the Touch 10, on screen, and on the
integrated touch screen have been updated. The main menu
items on the home screen have been replaced with more
prominent activities.
Some of the setting have been removed from the Touch 10
advanced settings menu to align with the on-screen display
menu.
Wakeup on motion detection
Wakeup on motion detection senses when a person
walks into the conference room and the system wakes up
automatically. You need to enable the following setting for this
feature to work:
xConfiguration Standby WakeupOnMotionDetection
You can’t manually place the system in standby when this
feature is enabled.
Updated In-Room Control Editor
The In-Room Control editor is updated with a new look,
improved logic and usability for producing a control interface
more efficiently. In addition, a new directional pad widget and
an In-Room Control simulator is added.
Added language support
We have added support for Potuguese (Portugal) to the
on-screen display and Touch controller menus.
Other changes
• Support for HTTPS client certificates has been added.
• Unplugging the presentation cable instantly stops the
presentation sharing.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 16
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
System configuration changes in CE9.0
New configurations
NetworkServices HTTPS Server MinimumTLSVersion
NetworkServices HTTPS StrictTransportSecurity
Configurations that are removed
None
Configurations that are modified
UserInterface Language
NEW: Portuguese added to value space
xConfigurations with INTERATOR user role
A new user role - INTEGR ATOR - is introduced in CE9.0. It has been added to the following
configurations:
Audio DefaultVolume
Audio Microphones Mute Enabled
Audio SoundsAndAlerts *
Conference DefaultCall Rate
Conference DoNotDisturb DefaultTimeout
SerialPort Mode
Standby *
SystemUnit Name
Time Zone
UserInterface OSD Output
Video Input Connector [n] CameraControl CameraId
Video Input Connector [n] CameraControl Mode
Video Input Connector [n] InputSourceType
Video Input Connector [n] Name
Video Input Connector [n] PresentationSelection
Video Input Connector [n] Quality
Video Input Connector [n] Visibility
Video Monitors
Video Output Connector [n] CEC Mode
Video Output Connector [n] Resolution
Video Presentation DefaultPIPPosition
Video Selfview Default *
Video Selfview OnCall *
<path> * means that the change applies to all configurations starting with <path>.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 17
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
xCommand changes in CE9.0
New commands
Audio Microphones ToggleMute
Audio Volume ToggleMute
Audio Sound Play
Audio Sound Stop
SystemUnit SignInBanner Clear
SystemUnit SignInBanner Get
SystemUnit SignInBanner Set
Commands that are modified
SystemUnit FactoryReset
NEW: Keep: LocalSetup, Network, Spark, Provisioning
xCommand with INTEGRATOR user role
Audio Microphones Mute
Audio Microphones ToggleMute
Audio Microphones Unmute
Audio Sound Play
Audio SoundsAndAlerts Ringtone List
Audio SoundsAndAlerts Ringtone Play
Audio Sound StopPeripherals Connect
Peripherals List
Standby Activate
Standby Deactivate
SystemUnit Boot
UserInterface Extensions Clear
UserInterface Extensions List
UserInterface Extensions Widget SetValue
UserInterface Extensions Widget UnsetValue
UserInterface Message Alert Clear
UserInterface Message Alert Display
UserInterface Message Prompt Clear
UserInterface Message Prompt Display
UserInterface Message Prompt Response
UserInterface Message TextLine Clear
UserInterface Message TextLine Display
UserInterface Presentation ExternalSource Add
UserInterface Presentation ExternalSource List
UserInterface Presentation ExternalSource Remove
UserInterface Presentation ExternalSource RemoveAll
UserInterface Presentation ExternalSource Select
UserInterface Presentation ExternalSource State Set
UserManagement User Passphrase Change
Video Input SetMainVideoSource
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 18
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
xStatus changes in CE9.0
New statuses
Video Output Connector [n] ConnectedDevice CEC [n] Name
Video Output Connector [n] ConnectedDevice CEC [n] VendorId
Statuses that are modified
Diagnostics Message [n] Type
OLD: CAPFOperationState, CTLinstallation, CUCMVendorConfigurationFile,
CallProtocolDualStackConfig, CallProtocolIPStackPlatformCompatibility, CallProtocolVcsPr
ovisioningCompatibility, CameraId, CameraPairing, CameraSerial, CameraSoftwareVersion,
CameraStatus, CamerasDetected, ConfigurationFile, DefaultCallProtocolRegistered,
EthernetDuplexMatches, FanStatus, PresenterTrack, H320GatewayStatus,
H323GatekeeperStatus, HasValidReleaseKey, IpCameraStatus, IPv4Assignment,
IPv6Assignment, IPv6Mtu, ISDNLinkCompatibility, ISDNLinkIpStack, ITLinstallation,
InvalidSIPTransportConfig, LockDown, RoomControl, MediaBlockingDetected,
NetLinkStatus, NetSpeedAutoNegotiated, NetworkQuality, NTPStatus,
OSDVideoOutput, OutputConnectorLocations, ProvisioningStatus, SIPEncryption,
SIPListenPortAndOutboundMode, SIPProfileRegistration, SIPProfileType, SelectedVideo
InputSourceConnected, SipIceAndAnatConflict, TCPMediaFallback, TemperatureCheck,
TLSVerifyRequiredCerts, TouchPanelConnection, ControlSystemConnection,
TurnBandwidth, UdpPortRangeViolation, UltrasoundSpeakerAvailability, ValidPasswords,
VideoFromInternalCamera, VideoInputStability, SparkConnectivity, SpeakerTrackFrontP
anelMountedCorrectly, SpeakerTrackMicrophoneConnection, SpeakerTrackVideoInputs,
SpeakerTrackEthernetConnection, ANATOnVCS, ECReferenceDelay, AudioECRefDelay,
AudioPairingNoise, AudioPairingRate, AudioPairingSNR, AudioPairingInterference,
AudioPairingTokenDecode, AudioInternalSpeakerDisabled, AbnormalCallTermination,
HasActiveCallProtocol, SipOrH323ButNotBothEnabled, PresentationSourceSelection,
SoftwareUpgrade, PlatformSanity, ContactInfoMismatch, MicrophoneReinforcement
NEW: CAPFOperationState, CTLinstallation, CUCMVendorConfigurationFile,
CallProtocolDualStackConfig, CallProtocolIPStackPlatformCompatibility, CallP
rotocolVcsProvisioningCompatibility, CameraId, CameraPairing, CameraSerial,
CameraSoftwareVersion, CameraStatus, CamerasDetected, ConfigurationFile,
DefaultCallProtocolRegistered, EthernetDuplexMatches, FanStatus, PresenterTrack,
H320GatewayStatus, H323GatekeeperStatus, HasValidReleaseKey, IpCameraStatus,
IPv4Assignment, IPv6Assignment, IPv6Mtu, ISDNLinkCompatibility, ISDNLinkIpStack,
ITLinstallation, InvalidSIPTransportConfig, LockDown, RoomControl,
MediaBlockingDetected, NetLinkStatus, NetSpeedAutoNegotiated, NetworkQuality,
NTPStatus, OSDVideoOutput, OutputConnectorLocations, ProvisioningDeveloperOptions,
ProvisioningStatus, SIPEncryption, SIPListenPortAndOutboundMode,
SIPProfileRegistration, SIPProfileType, SelectedVideoInputSourceConnec
ted, SipIceAndAnatConflict, SIPListenPortAndRegistration, TCPMediaFallback,
TemperatureCheck, TLSVerifyRequiredCerts, TouchPanelConnection,
ControlSystemConnection, TurnBandwidth, UdpPortRangeViolation,
UltrasoundSpeakerAvailability, ValidPasswords, VideoFromInternalCamera,
VideoInputStability, VideoInputSignalQuality, SparkConnectivity, SpeakerTrackFrontPa
nelMountedCorrectly, SpeakerTrackMicrophoneConnection, SpeakerTrackVideoInputs,
SpeakerTrackEthernetConnection, ANATOnVCS, ECReferenceDelay, AudioECRefDelay,
AudioPairingNoise, AudioPairingRate, AudioPairingSNR, AudioPairingInterference,
AudioPairingTokenDecode, AudioInternalSpeakerDisabled, AbnormalCallTermination,
HasActiveCallProtocol, SipOrH323ButNotBothEnabled, PresentationSourceSelection,
SoftwareUpgrade, PlatformSanity, ContactInfoMismatch, MicrophoneReinforcement,
FirstTimeWizardNotCompleted, CaptivePortalDetected, MonitorDelay
xStatus with INTEGRATOR user role
Audio Microphones Mute
Audio Output Connectors Line[n] DelayMs
Audio Volume
Call[n] FacilityServiceId
Call[n] ReceiveCallRate
Call[n] TransmitCallRate
Cameras Camera[n] Capabilities Options
Cameras Camera[n] Connected
Cameras Camera[n] Flip
Cameras Camera[n] HardwareID
Cameras Camera[n] MacAddress
Cameras Camera[n] Manufacturer
Cameras Camera[n] Model
Cameras Camera[n] Position Focus
Cameras Camera[n] Position Pan
Cameras Camera[n] Position Tilt
Cameras Camera[n] Position Zoom
Cameras Camera[n] SerialNumber
Cameras Camera[n] SoftwareID
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 19
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Introduction
API Reference Guide
Conference DoNotDisturb
Conference Presentation CallId
Conference Presentation LocalInstance[n] SendingMode
Conference Presentation LocalInstance[n] Source
Conference Presentation Mode
GPIO Pin[n] State
Peripherals ConnectedDevice[n] HardwareInfo
Peripherals ConnectedDevice[n] ID
Peripherals ConnectedDevice[n] Name
Peripherals ConnectedDevice[n] SoftwareInfo
Peripherals ConnectedDevice[n] Status
Peripherals ConnectedDevice[n] Type
Peripherals ConnectedDevice[n] UpgradeStatus
Standby State
SystemUnit State NumberOfActiveCalls
SystemUnit State NumberOfInProgressCalls
Time SystemTime
UserInterface Extensions Widget[n] Value
UserInterface Extensions Widget[n] WidgetId
Video ActiveSpeaker PIPPosition
Video Input Connector[n] Connected
Video Input Connector[n] SignalState
Video Input Connector[n] SourceId
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
Video Input Source[n] Resolution RefreshRate
Video Input Source[n] Resolution Width
Video Output Connector[n] Connected
Video Output Connector[n] ConnectedDevice CEC[n] DeviceType
Video Output Connector[n] ConnectedDevice CEC[n] Name
Video Output Connector[n] ConnectedDevice CEC[n] PowerControl
Video Output Connector[n] ConnectedDevice CEC[n] PowerStatus
Video Output Connector[n] ConnectedDevice CEC[n] VendorId
Video Output Connector[n] ConnectedDevice Name
Video Output Connector[n] ConnectedDevice PreferredFormat
Video Selfview FullscreenMode
Video Selfview Mode
Video Selfview OnMonitorRole
Video Selfview PIPPosition
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 20
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Chapter 2
About the API
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 21
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API fundamentals
This chapter contains a top-level view of the mechanisms
supported by the codec API.
Here you can read about how to access the API, how to use
the command line and what the different parts of the API
can be used for. This chapter also describes how to use the
feedback functions that are available for the codec.
The API consists of four major groups:
• Commands
• Configurations
• Status
• Events
These four groups are hierarchically organized, which
makes it easier to find related functionality. You can find the
complete lists of all commands, configurations and statuses
in the following chapters.
Connecting to the API
There are several ways to access the codec API. Regardless
of which method you choose, the structure of the API stays
the same. Choose the connection method that suits your
application best. Before you start, please read this section
about the different methods, as some of those may require
additional configuration changes before being enabled.
The following configurations, apart from password, can be set
from the System configuration menu on the web interface or
from the command line interface. All of the examples are for
the command line interface.
Password
The video system is delivered with a default user account
with full credentials. The user name is admin, and initially, no
password is set for the default user.
It is mandatory to set a password for the admin user in
order to restrict access to system configuration. You should
in addition set a password for any other user with similar
credentials.
You can set the password on the codec’s web interface.
Open a web browser and enter the IP address of the video
system in the address bar and log in. Click your user name in
the upper right corner and choose Change password in the
drop down menu.
API Reference Guide
SSH
SSH is a secure TCP/IP connection and it is enabled by
default on the codec. It can be disabled. You need a SSH
client, such as PuTTY, to access the API over SSH.
xConfiguration NetworkServices SSH Mode:
<O f f,O n>
Telnet
Telnet can be viewed as the equivalent of the serial protocol
in the TCP/IP world. Telnet is disabled by default. Before
connecting to the codec with Telnet you have to enable it.
To enable Telnet service, configure the following setting on
the codec. Changing this setting does not require a reboot of
the device, but it may take some time to take effect.
xConfiguration NetworkServices Telnet Mode:
<O f f,O n>
HTTP/HTTPS
As HTTP/HTTPS are connectionless protocols, there
is no persistent connection. There are several ways of
communicating with the API over HTTP.
In order to enable or disable the HT TP and HTTPS services,
configure the following setting on the codec.
xConfiguration NetworkServices HTTP Mode:
<Off, HTTP+HTTPS, HTTPS>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Connecting
You can inspect the API by entering the IP address or host
name of the codec in your favorite web browser. In the
web interface, you can find the API documents under the
menu section Integration > Developer API. The HTTP POST
and GET methods are used to execute commands and get
feedback from the codec. This is described in ”Using HTTP”
on page 33 in this document.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 22
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Serial connection over micro USB
You can use the micro USB connector for direct
communication with the video system. You may need to
install a serial por t driver on your computer manually.
Serial connection is allowed by default. It is mainly intended
for debugging.
xConfiguration SerialPort Mode: <Off/On>
Baud-rate and other serial port parameters
The serial port uses 115200 bps, 8 data bits, no parity and 1
stop bit.
Login and password
You can choose whether login is required or not for serial
connections. For security reasons the password prompting is
turned on by default, but it can be turned off if preferred.
xConfiguration SerialPort LoginReq uired: <Off/On>
User roles
A user account may hold one or a combination of user roles.
A user account with full access rights, like the default admin
user, should possess the ADMIN, USER and AUDIT roles.
These are the user roles:
ADMIN: A user with this role can create new users, change
most settings, make calls, and search the contact lists. The
user cannot upload audit certificates and change the security
audit settings.
USER: A user with this role can make calls and search the
contact lists. The user can modify a few settings, for example
adjust the ringtone volume and set the time and date format.
AUDIT: A user with this role can change the security audit
settings and upload audit certificates.
ROOMCONTROL: A user with this role can create in-room
controls. The user has access to the In-room control editor
and corresponding developement tools.
INTEGR ATOR: A user with this role has access to settings,
commands and status that are required to set up advanced
AV scenarios, and to integrate our video systems with 3rd
party equipment. 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 INTEGR ATOR and
ROOMCONTROL user roles are available.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 23
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API output
The xPreferences is used to set preferences for the RS-232,
Telnet and SSH sessions.
API Reference Guide
Example: Layout command in terminal mode
The output modes
• Terminal: Line based output for use with line based
control systems
• XML: XML output for use with control systems that
understand XML.
• JSON: JSON format is convenient when integrating with
web based systems.
The default output mode is terminal. To change this you
have to define your preferences for each session individually.
Examples in this guide are in terminal mode.
To set output mode to XML, issue the command:
xPreferences outputmode xml
To revert to terminal mode, issue the command:
xPreferences outputmode terminal
xCom mand Audio Volume Set Level: 50
Example: Layout command in XML mode
<Command>
<Audio>
<Volu m e>
<Set command=”True”>
<Level>50</Level>
</Set >
</Volu m e>
</Au d io>
</Command>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 24
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Using the command line
Help
To get a list of all supported top level commands you can
type ? or help after connecting to the TelePresence System
using RS-232, Telnet or SSH (Example 1).
Bye
Typing the bye command closes the command line interface.
API commands
xConfiguration
Configurations are system settings, such as system name
and network settings. These are persistent across boots.
Refer to ”Configurations” on page 27.
xCommand
Commands instruct the codec to execute actions, such as to
dial a number or to search the phone book.
Refer to ”Commands” on page 27.
xStatus
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources.
Refer to ”Status” on page 27.
xFeedback
The Feedback commands are used to specify what parts of
the configuration and status hierarchies to monitor. Feedback
is only issued on the RS-232, Telnet or SSH session for
which it is specified. If you are connecting to the codec with
multiple sessions, you have to define feedback individually
for each session. Refer to ”Feedback mechanism” on page
31.
Example 1:
?
- User Commands -
help
xgetxml xdocument xpreferences xtransaction xstatus
bye echo log systemtools
OK
xPreferences
The xPreferences command is used to set preferences for
the RS-232, Telnet and SSH sessions.
Refer to ”API output” on page 24.
Echo <on/off>
If echo is set to On the key inputs are displayed when
entering text in a command line interface.
If echo is set to Off user input is not displayed when entering
text in a command line interface.
xEvent
The xEvent command returns information on which events are
available for feedback. Refer to ”Events” on page 30.
xGetxml
The xGetxml request returns an XML document based on the
location parameter attached to the request. The elements
(or a complete document) matching the expression will be
returned. Refer to ”Feedback mechanism” on page 31.
xcom mand xconfiguration xevent xfeedback
Other commands
Systemtools
The systemtools commands are a set of command line tools
for administrative control and diagnostics. The commands
can be used for advanced troubleshooting together with
Cisco technical support. Systemtools are not a part of the
programming API. Refer to ”The SystemTools commands”
on page 198.
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 25
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Command line shortcuts
If your client supports it, there are some timesaving shortcuts
you can use:
• Tab-completion to complete the commands and
arguments.
• Arrow up and arrow down keys to navigate your
command history.
• <CTRL-a>: Jump to the beginning of the line.
• <CTRL-e>: Jump to the end of the line.
• <CTRL-r>: Incremental command history search.
• <CTRL-w>: Erase the current line.
Searching
You can use // to search for elements anywhere in the status
or configuration hierarchy (Example 1).
You can also combine multiple //’s (Example 2).
NOTE: The search shortcuts work well for inspecting the
API, but should not be used in applications. We recommend
that you always use the complete paths to avoid command
ambiguity when upgrading to newer firmware releases.
Example 1:
List all configurations that include words that starts with OUT
and HDMI:
x c o n f i g u r a t i o n //o u t // h d m i
*c xConfiguration Audio Output HDMI 1 Level: 0
*c xConfiguration Audio Output HDMI 1 Mode: On
*c xConfiguration Audio Output HDMI 2 Level: 0
*c xConfiguration Audio Output HDMI 2 Mode: Off
** end
Example 2:
Get the resolution width of all connected sources for both
inputs and outputs:
x S t a t u s //v i d //r e s // w i d
*s Video Input Source 1 Resolution Width: 1920
*s Video Input Source 2 Resolution Width: 0
*s Video Input Source 3 Resolution Width: 0
*s Video Input Source 4 Resolution Width: 0
*s Video Output Connector 1 Resolution Width: 1920
*s Video Output Connector 2 Resolution Width: 1280
*s Video Output Connector 3 Resolution Width: 1280
** end
Value types and formats
The system supports the following value types:
• Integer values: <x..y>
Defines the valid range for an integer input. x = min value,
y = max value.
• Literal values: <X/Y/../Z>
Defines the possible values for a given configuration.
• String values: <S: x, y>
Defines that the valid input for this configuration is a
string with minimum length of x and maximum length of
y characters. Strings can have rules that further specify
their format and length.
Input values that contain spaces need to be quoted
Any values for configurations and commands containing
spaces must be enclosed in quotes. Quotes are not
necessary for values without spaces.
Example:
Correct:
contains spaces”
Correct:
Incorrect:
contains spaces
Case sensitivity
All commands are case-insensitive. All of the following
commands will work.
XCOMMAND DIAL NUMBER: foo@bar.org
xcom mand dial nu mber: foo@bar.org
xCom mand Dial Number: foo@bar.org
xCommand dial number: “my number
xCommand dial number: 12345
xCommand dial number: my number
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 26
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Commands
Commands instruct the codec to execute actions, such as
to dial a number or to search the phone book. All commands
start with the prefix xCommand followed by a command path.
Writing xCommand ? on the command line will list all the top
level commands.
To view the complete list of commands and their parameters,
write xCommand ?? on the command line.
Command arguments are key-value pairs.
When issuing a xCommand, the command consists of one
argument and one required parameter. In this document the
command usage is described for all xCommands, with both
required and optional parameters. The optional parameters
are in brackets.
Example: xCommand Dial Number: 123
• xCommand is the command prefix. The command to be
executed is Dial.
• The example contains one argument, Number: 123.
Number is the key and 123 is its value. The key/value pair
is separated with ‘:’.
Configurations
Configurations are system settings that are persistent across
boots. Like commands, also configurations are structured in
a hierarchy.
Writing xConfiguration ? on the command line lists all the top
level configurations.
Writing xConfiguration ?? lists all configurations and their
value spaces.
Writing xConfiguration lists all configurations and their
current values. To list out only some of the configurations,
write xConfiguration followed by one or more parts of the
configuration paths.
Example: Set the H323 Alias ID
Write in:
xConfiguration H323 Profile 1 H323Alias ID:
“changed@company.com”
Example: Get the H323 Alias ID
Write in:
xConfiguration H323 Profile 1 H323Alias ID
Result:
*c xConfiguration H323 Profile 1 H323Alias ID:
“changed@company.com”
**end
Status
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources.
Writing xStatus ? on the command line lists all top level
statuses.
Writing xStatus lists all statuses and their current values.
To list out only some of the statuses, write xstatus followed by
the relevant part of the status path (address expression):
xStatus <address expression>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 27
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
Multiline commands
Multiline commands are commands that support larger
amounts of data as input than the single line commands.
Typical use for these commands is to allow for provi-
sioning of in-room control definitions, branding images
(base64 encoded), macros, welcome banners, and security
certificates.
To issue a multiline command, you start issuing it like
any other XAPI command. However, once you enter the
command, you have set the API into an input mode where
anything you issue on the API after this is treated as input
to that command, including line breaks. You now enter the
payload for this command in accordance to the input format
expected by this command
When done, finish with a line break(“\n”) and a separate line
containing just a period ending with a line break (“.\n”). The
command will now be executed, and you will get a command
result with an OK or ERROR depending on the command
being executed successfully or not.
The commands that require multiline input format are marked
as such in the command descriptions in this guide.
The multiline commands are marked as multiline in
xCommand overview section in this guide.
API Reference Guide
Example: Set up welcome banner text
xCommand SystemUnit SignInBanner Set
Hell o!
This is the second line of text.
This is the third.
Thank yo u!
.
OK
*r SignInBannerSetResult (status=OK):
** end
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 28
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Synchronous API calls
The API works asynchronously. This means that there is no
guarantee that command responses arrive in the same order
as the commands were issued. The codec may also respond
with feedback between your request and the response, in
form of status changes or events, due to changes on the
system.
For some applications it might be crucial to match requests
with responses. The API therefore supports a responsetagging mechanism.
This mechanism works with all command types: xcommand,
xconfiguration, and xstatus. A typical use of this would be
to create a command queue in your application and assign
unique IDs to every command sent to the codec. A listener
then listens to all feedback from the codec and matches
the ID on the response with the corresponding ID in the
command queue. This enables matching the original request
with the specific response.
Example:
xcommand Video Layout Add | resultId=”mytag _ 1”
OK
*r VideoLayoutAddResult (status=OK):
LayoutId: 1
** resultId: “mytag _ 1”
** end
In XML mode the resultId is added as an attribute to the top-level XmlDoc tag:
xget x ml /Configuration/Video/Layout/Scaling | resultId=”my tag _ 2”
<X mlDoc resultId=”my tag _ 2”>
<Configuration item=”1”>
< Vid e o ite m =”1”>
<L a y o ut ite m =”1”>
<Scaling item=”1” valueSpaceRef=”...”>Off</Scaling>
</Layout>
</Vid eo>
</Configuration>
</XmlD oc>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 29
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Events
Event returns information about the events that are available
for feedback. This overview presents examples of some the
events that are available on the API.
To get an overview of the supported events type ?, ?? or help
after xEvent:
• xEvent ? Lists the top level events
• xEvent ?? List all of the available events
• xEvent help Lists the top level events
The result for events depends on the state of the codec.
Example 1: Outgoing Call Indication
Outgoing Call Indication is an event reported when an
outgoing call is about to be dialled. Returns the CallId the
call has been assigned.
*e OutgoingCallIndication CallId: x
** end
Example 2: Call Disconnect
Call Disconnect is an event reported when a call is
disconnected. Returns the CallId of the disconnected call
and reason for the call’s disconnection.
*e CallDisconnect CallId: x CauseValue: 0
CauseString: “” CauseType: LocalDisconnect
OrigCallDirection: “outgoing”
** end
Example 3: Call Successful
Call Succesful is an event reported when a call is
connected successfully, that is when all channels are up
and established.
*e CallSuccessful CallId: 132 Protocol: “h223”
Direction: “outgoing” CallRate: 768 RemoteURI:
“h223:integratorHQ@company.com” EncryptionIn:
“Off” Encry ptionOut: “Off”
** end
Example 4: FECC Action request
FECC Action request is an event reported when far end is
sending FECC commands.
*e FeccActionInd Id: 132 Req: 1 Pan: 1 PanRight:
1 Tilt: 0 TiltUp: 0 Zoom: 0 ZoomIn: 0 Focus: 0
FocusIn: 0 Timeout: 300 VideoSrc: 0 m: 0
** end
Example 5: TString message received
TString message received is an event reported when far
end has sent a TString message.
*e TString CallId: 132 Message: “ee”
** end
Example 6: SString message received
SString message received is an event reported when far
end has sent a SString message.
*e SString String: “ee” Id: 132
** end
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 30
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Feedback mechanism
To build solutions that can reliably keep the state between
your application and the codec synchronized, you can set up
a notification system to report the changes in the state of the
codec.
The API supports notifications on the following:
• Configuration changes
• Status changes
• Event notifications
These notifications will not be sent unless you have explicitly
told the codec to do so. You can subscribe to the feedback
by registering feedback expressions. How you register
feedback expressions varies according to the connection
method used.
When using HTTP, the method of handling feedback differs
slightly from what is presented in this section. See the
”Feedback from codec over HTTP” on page 35 for more
information.
WARNING: A codec may give very much feedback,
especially when calls are connected and disconnected.
Do only subscribe to the feedback you need.
Never register for all status feedback by issuing
xFeedback register /Status. This may give the control
application too much data to handle, which may lead to
sluggish or unpredictable behavior.
Feedback expressions
The expression used when registering for feedback is a
variant of the XPath language. The XPath language describes
a way to select nodes from an XML/JSON document. The CE
software contains three main feedback documents.
Document API command Path
Status xStatus /Status
Configuration xConfiguration /Configuration
Event xEvent /Event
The syntax for feedback registering is:
xFeedback register <path>
Never register for all status feedback by issuing xFeedback
register /Status.
It is safe to register for all configuration changes using
xFeedback register /Configuration,
changes will most likely not occur that often.
By going through some examples, we can see how this
information can be used to build feedback expressions. A
good way to verify the expressions is to point your browser
to http://<ip-address>/getxml?location=path or to execute
xget x ml <path>
matches the nodes you want feedback on.
from the terminal, and check that the output
as configuration
Example 1: Microphones Mute status.
Terminal query
xStatus Audio Microphones Mute
*s Audio Microphones Mute: Off
** end
Equivalent feedback expression
xFeedback register /Status/Audio/Microphones/Mute
Example 2: Name of all video input connectors.
Terminal query
xConfiguration Video Input Connector Name
*c xConfiguration Video Input Connector 1 Name:
“N a m eA”
*c xConfiguration Video Input Connector 2 Name:
“Na meB”
*c xConfiguration Video Input Connector 3 Name:
“Nam eC”
*c xConfiguration Video Input Connector 4 Name:
“Nam eD”
*c xConfiguration Video Input Connector 5 Name:
“NameE”
** end
Equivalent feedback expression
xFeedback register /Configuration/Video/Input/
Connector/Name
Example 3: Name of video input connector 3.
Terminal query
xConfiguration Video Input Connector 3 Name
*c xConfiguration Video Input Connector 3 Name:
“Nam eC”
** end
Equivalent feedback expression
xFeedback register /Configuration/Video/Input/
Connector[@item=’3’]/Name
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 31
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Terminal connections
Managing feedback subscriptions
To register, list and deregister feedback expressions you
use the command xFeedback and its corresponding sub
commands.
The registered expressions are only valid for the currently
active connection. If you open two Telnet sessions and
register to get feedback in one session, you do not receive
feedback in the other session. This also means that if you
disconnect from a session, you have to re-register all
expressions after reconnecting.
You can register up to 38 expressions.
Feedback output
The feedback output is exactly the same as you get when
querying the system using the xConfiguration and xStatus
commands. E.g., if you issue the command
Ac tive
on the command line the result is:
*s Standby Active: On
** end
If you have registered for feedback on status changes the
feedback you get when the system goes to standby-mode
will be exactly the same:
*s Standby Active: On
** end
This means that when you are programming against the
device you only need to handle one format.
xStatus Standby
Example: Managing feedback subscriptions
A: Register feedback expressions.
Write in:
Result:
Write in:
Result:
Write in:
xFeedback register /Status/Audio
** end
OK
xFeed back register /Event/CallDisconnect
** end
OK
xFeedback register /Configuration/Video/
MainVideoSource
Result:
B: List out currently registered expressions.
Write in:
Result:
C: Deregister feedback expressions.
Write in:
Result:
Write in:
Result:
D: List the new feedback expressions.
Write in:
Result:
** end
OK
xFeedback list
/Configuration/Video/MainVideoSource
/Event/CallDisconnect
/St a tus/A u d io
** end
OK
xFeed back deregister /Event/CallDisconnect
** end
OK
xFeedback deregister /Status/Audio
** end
OK
xFeedback list
/Configuration/Video/MainVideoSource
** end
OK
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 32
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Using HTTP
The codec supports sending commands and configurations
over HTTP and HTTPS. It is also possible to retrieve
configurations and statuses this way. This interface exposes
the same API as the command line, but in XML format.
HTTP XMLAPI Authentication
Access to the XMLAPI requires the user to authenticate using
HTTP Basic Access Authentication as a user with ‘ADMIN’
role. Unauthenticated requests prompt a 401 HTTP response
containing a Basic Access Authentication challenge. How to
use HTTP Basic Access Authentication varies according to
the HTTP library or tool that you are using.
If your application will be issuing multiple commands
through the API, we highly recommend that you use Session
Authentication (see below). The standard basic authentication
does a full re-authentication per request, which may affect
the performance of your application.
HTTP XMLAPI Session Authentication
Authenticating with your username and password
combination for each API request might introduce too
much latency for some use-cases. To mitigate this, the API
supports a session-based authentication mechanism.
To open a session, issue a POST to http://<ip-address>/
xmlapi/session/begin with Basic Access Authentication. The
response sets a SessionId-cookie that can be used with
subsequent requests.
Note that when using API Session Authentication, it is
important to explicitly close the session when you are done.
Failing to do so may cause the device to run out of sessions,
as there are a limited number of concurrent sessions
available, and they do not time out automatically.
URL cheat sheet
The following table contains the main URLs used when accessing the API over HTTP.
Method URL Description
GET http://<ip-address>/status.xml Complete status document
GET http://<ip-address>/configuration.xml Complete configuration document
GET http://<ip-address>/command.xml Complete command document
GET http://<ip-address>/valuespace.xml Complete valuespace document
GET http://<ip-address>/getxml?location=<path> Retrieve document based on a path
POST http://<ip-address>/putxml Configurations and commands in HTTP body
Example: Starting a HTTP XMLAPI session
Request:
POST /xmlapi/session/begin HTTP/1.1
Authorization: Basic <Base64 encoded
authentication string>
Response:
HTTP/1.1 204 No Content
Server: nginx/1.8.0
Connection: keep-alive
Set-Cookie: SessionId=f08102c8ce5aaf8fba23a7238
cc2ef464b990e18bfbb7fb048820c0e28955c54; Path=/;
HttpOnly
This session counts toward the systems concurrent sessions
limit.
With an open session, provide the SessionId cookie to
following requests. Your tool/library may do this automatically.
Example: Using a HTTP XMLAPI session
Request:
GET /configuration.xml HTTP/1.1
Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46
4b990e18bfbb7fb048820c0e28955c54
Response:
HTTP/1.1 200 OK
Server: nginx/1.8.0
Content-Type: text/xml; charset=UTF-8
Co nt ent-Le n g th: 43549
Connection: keep-alive
<?xml version=”1.0”?>
<Configuration product=”Cisco Codec”
version=”ce8.2.0” apiVersion=”4”> ...
</Configuration>
To close a session after use, issue a POST to http://<ip-
address>/xmlapi/session/end with the provided cookie.
Example: Closing a HTTP XMLAPI session
Request:
POST /xmlapi/session/end HTTP/1.1
Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46
4b990e18bfbb7fb048820c0e28955c54
Response:
HTTP/1.1 204 No Content
Server: nginx/1.8.0
Connection: keep-alive
Set-Cookie: SessionId=; Max-Age=0; Path=/;
HttpOnly
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 33
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Getting status and configurations
Example 1: Get all status entries on the codec.
http://<ip-address>/getxml?location=/Status
Example 2: Get just the audio statuses of the codec.
http://<ip-ad dress>/getx ml?location=/Status/Audio
Example 3: Get all configurations of the codec.
http://<ip-add ress>/get xml?location=/Configuration
Example 4: Get all video configurations of the codec.
http://<ip-add ress>/get xml?location=/Configuration/
Vide o
Sending commands and configurations
Using HTTP POST
When sending configurations and commands to the codec, it
is important that the HTTP header Content-Type is set to text/
xml, i.e. Content-Type: text/xml. The body of the POST should
contain the XML content.
Example 1: Changing the system name.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
<Configu ration>
<SystemUnit>
<Name>newName</Name>
</Syst e m U n it>
</Configuration>
Example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
<Command>
<Camera>
<PositionSet command=”True”>
<C a m e r a Id >1</C a m e r aId >
<Pan>200</Pan>
<Tilt>200</Tilt>
</Position Set>
</Camera>
</Command>
Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 91
<?xml version=”1.0”?>
<Command>
<Ca m e ra Po sitionSetResu lt ite m=”1” st atus =”OK”/>
</Command>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 34
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
Feedback from codec over HTTP
You can get the device to post http feedback messages
(also known as webhooks) on changes to the API state, e.g.
statuses, events and configuration updates. The HTTP Post
feedback messages will be sent to the specified ServerURL.
You can choose between events being posted in either XML
or JSON format. You can subscribe to changes on multiple
parts of the API by register up to 15 different feedback
expressions.
Registering for feedback
The command for registering is
Register
described in this section.
HttpFeedback Register syntax:
. The syntax for this command and its arguments are
xCom mand HttpFeedback Register
FeedbackSlot: <1..4>
ServerUrl(r): <S: 1, 2048>
Format: <XML/JSON>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
xComma nd HttpFeedback
HttpFeedback Register arguments:
FeedbackSlot: The codec can register up to 4 slots of servers
requesting HTTP feedback. Set the registering to one of them.
NOTE: Avoid using FeedbackSlot 3 in an environment where
Cisco TelePresence Management Suite (TMS) is used as TMS
uses this feedback slot to register its expressions.
ServerUrl: The URL to the HTTP server where you want the
codec to post the HTTP feedback messages to.
Format: Set the format for the feedback from the HTTP server
to XML or JSON.
Expression 1-15: The XPath expression specifies which parts
of the Status, Configuration or Event documents are monitored.
You can have from 1 to 15 XPath expressions
Register the expressions you want to receive feedback on.
See the “Feedback mechanism” on page 31 section for
more information about the expression formats.
Example: Registering feedback on configuration changes,
disconnect events and call status changes.
POST /putxml HTTP/1.1
Content-Type: text/xml
<Command>
<HttpFeedback>
<Register com mand=”True”>
<FeedbackSlot>1</FeedbackSlot>
<S er v e r Url>ht t p://127.0.0.1/
myhttpp ostscripturl</ServerUrl>
<Format>XML</Format>
<Expression item=”1”>/Configuration</
Expression>
<Expression item=”2”>/Event/
CallDisconnect</Expression>
<Expression item=”3”>/Status/Call</
Expression>
</Register>
</HttpFeed back>
</Command>
API Reference Guide
Feedback output
When the codec notifies the registered HTTP server about
changes, the body contains the same XML as when polling.
There is however one small difference. The root-node
contains an Identification node with children that specify the
codec from which the notification originated. This means that
you can handle multiple codecs with a single HTTP server URI.
Example: Audio volume changed.
<Configuration xmlns=”http://www.company.com/XML/
CUIL /2.0” >
<Identification>
<SystemNa me>My System Name</SystemName>
<M AC A d d r ess >00:00:d e:ad:b e:e f</M A CAddres s>
<I PAd d r es s >192.168.1.100 </I PAd d r e s s >
<ProductType>Cisco Codec</ProductType>
<ProductID>Cisco Codec DX80</ProductID>
<S W Versio n >CE8.3.0.19 9465</SW Ve r sion>
<HW B o a r d>101401-5 [08]</ H W B oa rd>
<SerialNumber>PH0000000</SerialNu m ber>
</Identification>
<Audio item=”1”>
<Volu m e item=”1”>60</Volume>
</Au d io>
</Configuration>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 35
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
API Reference Guide
Translating from terminal mode to XML
Translating commands
The XML commands maintain the same structure as the
terminal commands, but they use a parent-child relationship
to describe the hierarchy. You can see this structure in the
examples below.
Example 1: Setting up a call.
Terminal
xCom mand Dial Number: “12345” Protocol: H323
XML
<Command>
<Dial command=”True”>
<Nu m b er>12345</Num b er>
<Protocol>H323</Protocol>
</Dia l>
</Command>
Example 2: Assigning volume level
Terminal
xCom mand Audio Volume Set Level: 50
XML
<Command>
<Audio>
<Volu m e>
<Set command=”True”>
<Level>50</Level>
</Set >
</Volu m e>
</Au d io>
</Command>
Translating configurations
Translating from xConfiguration to XML is similar to commands,
but with the addition of a special attribute item=”NN” for
specifying the index in arrays.
Example: Configuring the input source type for video input
connector 2.
Terminal
xConfiguration Video Input Connector 2
InputSourceTy pe: camera
XML
<Configu ration>
<Vid eo>
<Input>
<Connector item=”2”>
<InputSourceType>camera</InputSourceType>
</Connector>
</In put >
</Vid eo>
</Configuration>
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 36
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API
Dos and don’ts
Here are some best practices when programming the Cisco
series API.
DO use complete commands
You should always use complete commands when
programming, i.e. always use xConfiguration Video instead of
xconf vid. The shortcuts can be used for searches in the API
on the command line, but not for programming. The reason
for this is that you might end up with ambiguous code when
additional commands are added to the API.
DO NOT subscribe to unnecessary feedback
Subscribing to too much feedback may congest the control
application. Although the amount of feedback may seem fine
in the current version, the amount of feedback may grow in
future releases.
API Reference Guide
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 37
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration commands
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Chapter 3
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 38
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
Description of the xConfiguration commands
In this chapter, you can find a complete list of the xConfiguration commands. The examples
show either the default value or an example of a value.
We recommend you visit our web site regularly for updated versions of the manual.
Go to: http://www.cisco.com/go/dx-docs
API Reference Guide
Audio configuration .............................................................................................................................. 43
xConfiguration Audio DefaultVolume
xConfiguration Audio Microphones Mute Enabled
xConfiguration Audio SoundsAndAlerts RingTone
xConfiguration Audio SoundsAndAlerts RingVolume
xConfiguration Audio Input MicrophoneMode
xConfiguration Audio Ultrasound MaxVolume
Conference configuration
xConfiguration Conference AutoAnswer Mode
xConfiguration Conference AutoAnswer Mute
xConfiguration Conference AutoAnswer Delay
xConfiguration Conference DefaultCall Protocol
xConfiguration Conference DefaultCall Rate
xConfiguration Conference DoNotDisturb DefaultTimeout
xConfiguration Conference Encryption Mode
xConfiguration Conference FarEndControl Mode
xConfiguration Conference MaxReceiveCallRate
xConfiguration Conference MaxTransmitCallRate..................................................................................... 46
xConfiguration Conference MaxTotalReceiveCallRate
xConfiguration Conference MaxTotalTransmitCallRate
H323 configuration
xConfiguration H323 Authentication Mode
xConfiguration H323 Authentication LoginName
xConfiguration H323 Authentication Password
xConfiguration H323 CallSetup Mode....................................................................................................... 48
..................................................................................................................... 44
............................................................................................................................... 47
........................................................................................................ 43
.................................................................................... 43
.................................................................................... 43
............................................................................... 43
.......................................................................................... 44
.......................................................................................... 44
........................................................................................ 44
......................................................................................... 44
.........................................................................................45
.......................................................................................45
.............................................................................................45
........................................................................45
........................................................................................... 46
..................................................................................... 46
..................................................................................... 46
............................................................................... 47
.............................................................................. 47
................................................................................................ 47
....................................................................................... 47
........................................................................................ 48
xConfiguration H323 Encryption KeySize
xConfiguration H323 Gatekeeper Address
xConfiguration H323 H323Alias E164
xConfiguration H323 H323Alias ID
xConfiguration H323 NAT Mode
xConfiguration H323 NAT Address
Macros configuration
xConfiguration Macros Mode
xConfiguration Macros AutoStart
Network configuration
xConfiguration Network [1] DNS Domain Name
xConfiguration Network [1] DNS Server [1..3] Address
xConfiguration Network [1] IEEE8021X Mode
xConfiguration Network [1] IEEE8021X TlsVerify
xConfiguration Network [1] IEEE8021X UseClientCertificate
xConfiguration Network [1] IEEE8021X Identity
xConfiguration Network [1] IEEE8021X Password
xConfiguration Network [1] IEEE8021X AnonymousIdentity
xConfiguration Network [1] IEEE8021X Eap Md5
xConfiguration Network [1] IEEE8021X Eap Ttls
xConfiguration Network [1] IEEE8021X Eap Tls
xConfiguration Network [1] IEEE8021X Eap Peap
xConfiguration Network [1] IPStack
xConfiguration Network [1] IPv4 Assignment
xConfiguration Network [1] IPv4 Address
............................................................................................................................ 50
.................................................................................................................... 50
...........................................................................................................................51
................................................................................................. 48
............................................................................................... 48
....................................................................................................... 49
............................................................................................................ 49
............................................................................................................... 49
........................................................................................................... 50
.............................................................................................................. 50
......................................................................................... 51
............................................................................................. 51
........................................................................................ 51
..........................................................................................52
......................................................................................52
....................................................................................... 53
........................................................................................ 53
......................................................................................... 53
...................................................................................... 53
............................................................................................................54
.............................................................................................54
...................................................................................................54
.............................................................................. 51
.....................................................................52
.......................................................................52
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 39
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IPv4 Gateway ..................................................................................................54
xConfiguration Network [1] IPv4 SubnetMask
xConfiguration Network [1] IPv6 Assignment
xConfiguration Network [1] IPv6 Address
xConfiguration Network [1] IPv6 Gateway
xConfiguration Network [1] IPv6 DHCPOptions
xConfiguration Network [1] MTU
xConfiguration Network [1] QoS Mode
xConfiguration Network [1] QoS Diffserv Audio
xConfiguration Network [1] QoS Diffserv Video
xConfiguration Network [1] QoS Diffserv Data
xConfiguration Network [1] QoS Diffserv Signalling
xConfiguration Network [1] QoS Diffserv ICMPv6
xConfiguration Network [1] QoS Diffserv NTP
xConfiguration Network [1] RemoteAccess Allow
xConfiguration Network [1] Speed
xConfiguration Network [1] VLAN Voice Mode
xConfiguration Network [1] VLAN Voice VlanId
NetworkPort configuration
xConfiguration NetworkPort [2] Mode
NetworkServices configuration
xConfiguration NetworkServices CDP Mode
xConfiguration NetworkServices H323 Mode
xConfiguration NetworkServices HTTP Mode
xConfiguration NetworkServices HTTP Proxy Allowed
xConfiguration NetworkServices HTTP Proxy LoginName
xConfiguration NetworkServices HTTP Proxy Password
xConfiguration NetworkServices HTTP Proxy Mode
xConfiguration NetworkServices HTTP Proxy Url
xConfiguration NetworkServices HTTPS Server MinimumTLSVersion
xConfiguration NetworkServices HTTPS StrictTransportSecurity
xConfiguration NetworkServices HTTPS VerifyServerCertificate
xConfiguration NetworkServices HTTPS VerifyClientCertificate
............................................................................................................... 56
............................................................................................................ 60
................................................................................................................... 61
............................................................................................................ 61
............................................................................................55
.............................................................................................55
..................................................................................................55
..................................................................................................55
......................................................................................... 56
...................................................................................................... 56
.........................................................................................57
.........................................................................................57
.......................................................................................... 58
.................................................................................. 58
..................................................................................... 59
.......................................................................................... 59
..................................................................................... 59
......................................................................................... 60
......................................................................................... 60
........................................................................................................ 61
............................................................................................. 61
...........................................................................................61
...........................................................................................62
.............................................................................62
........................................................................62
..........................................................................62
................................................................................ 63
..................................................................................... 63
.................................................... 63
............................................................ 63
.............................................................64
...............................................................64
xConfiguration NetworkServices NTP Mode
xConfiguration NetworkServices NTP Server [1..3] Address
xConfiguration NetworkServices SIP Mode
xConfiguration NetworkServices SNMP Mode
xConfiguration NetworkServices SNMP Host [1..3] Address
xConfiguration NetworkServices SNMP CommunityName
xConfiguration NetworkServices SNMP SystemContact
xConfiguration NetworkServices SNMP SystemLocation
xConfiguration NetworkServices SSH Mode
xConfiguration NetworkServices Telnet Mode
xConfiguration NetworkServices WelcomeText........................................................................................ 66
Peripherals configuration
xConfiguration Peripherals Profile ControlSystems
Phonebook configuration
xConfiguration Phonebook Server [1] ID
xConfiguration Phonebook Server [1] Type
xConfiguration Phonebook Server [1] URL
Provisioning configuration
xConfiguration Provisioning Connectivity
xConfiguration Provisioning Mode
xConfiguration Provisioning LoginName
xConfiguration Provisioning Password
xConfiguration Provisioning HttpMethod
xConfiguration Provisioning ExternalManager Address
xConfiguration Provisioning ExternalManager AlternateAddress
xConfiguration Provisioning ExternalManager Protocol
xConfiguration Provisioning ExternalManager Path
xConfiguration Provisioning ExternalManager Domain
Proximity configuration
xConfiguration Proximity Mode
xConfiguration Proximity Services CallControl
..................................................................................................................... 67
..................................................................................................................... 67
.................................................................................................................... 68
............................................................................................................ 69
..........................................................................................................................71
.................................................................................................................. 71
.............................................................................................64
.....................................................................64
...............................................................................................65
..........................................................................................65
.....................................................................65
.......................................................................65
......................................................................... 66
........................................................................ 66
............................................................................................ 66
......................................................................................... 66
...................................................................................67
....................................................................................................67
................................................................................................67
................................................................................................ 68
................................................................................................. 68
................................................................................................... 69
...................................................................................................... 69
...................................................................................................70
.............................................................................70
..............................................................70
.............................................................................70
................................................................................... 71
.............................................................................. 71
.......................................................................................... 71
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 40
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Proximity Services ContentShare FromClients .................................................................72
xConfiguration Proximity Services ContentShare ToClients
SerialPort configuration
xConfiguration SerialPort Mode
xConfiguration SerialPort LoginRequired
SIP configuration
xConfiguration SIP Authentication UserName
xConfiguration SIP Authentication Password
xConfiguration SIP DefaultTransport
xConfiguration SIP DisplayName
xConfiguration SIP Ice Mode
xConfiguration SIP Ice DefaultCandidate
xConfiguration SIP ListenPort
xConfiguration SIP Proxy [1..4] Address
xConfiguration SIP Turn Server
xConfiguration SIP Turn UserName
xConfiguration SIP Turn Password
xConfiguration SIP URI
Standby configuration
xConfiguration Standby Control
xConfiguration Standby Delay
xConfiguration Standby WakeupOnMotionDetection
SystemUnit configuration
xConfiguration SystemUnit Name
Time configuration
xConfiguration Time TimeFormat
xConfiguration Time DateFormat
xConfiguration Time Zone
UserInterface configuration
........................................................................................................................ 72
.................................................................................................................72
...................................................................................................72
.................................................................................................................................. 73
...........................................................................................73
.............................................................................................73
..........................................................................................................73
...............................................................................................................73
......................................................................................................................74
................................................................................................... 74
....................................................................................................................74
..................................................................................................... 74
..................................................................................................................75
...........................................................................................................75
.............................................................................................................75
...............................................................................................................................75
.......................................................................................................................... 76
.................................................................................................................76
....................................................................................................................76
..................................................................................................................... 77
..............................................................................................................77
................................................................................................................................ 77
...............................................................................................................77
...............................................................................................................77
..........................................................................................................................78
.................................................................................................................. 79
......................................................................72
................................................................................76
xConfiguration UserInterface ContactInfo Type
xConfiguration UserInterface CustomMessage
xConfiguration UserInterface KeyTones Mode
xConfiguration UserInterface Language
xConfiguration UserInterface OSD HalfwakeMessage
xConfiguration UserInterface OSD Output
xConfiguration UserInterface OSD SettingsMenu Mode
UserManagement configuration
xConfiguration UserManagement LDAP Mode
xConfiguration UserManagement LDAP Server Address
xConfiguration UserManagement LDAP Server Port
xConfiguration UserManagement LDAP Encryption
xConfiguration UserManagement LDAP MinimumTLSVersion
xConfiguration UserManagement LDAP VerifyServerCertificate
xConfiguration UserManagement LDAP Admin Filter
xConfiguration UserManagement LDAP Admin Group
xConfiguration UserManagement LDAP Attribute
Video configuration
xConfiguration Video DefaultMainSource
xConfiguration Video Input Connector [1..2] CameraControl Mode
xConfiguration Video Input Connector [1..2] CameraControl CameraId
xConfiguration Video Input Connector [1..2] InputSourceType
xConfiguration Video Input Connector [1..2] Name
xConfiguration Video Input Connector [2] PresentationSelection
xConfiguration Video Input Connector [2] Quality
xConfiguration Video Input Connector [1..2] Visibility
xConfiguration Video Monitors
xConfiguration Video Output Connector [2] CEC Mode
xConfiguration Video Output Connector [2] OverscanLevel
xConfiguration Video Output Connector [1..2] Resolution
xConfiguration Video Presentation DefaultSource.....................................................................................87
xConfiguration Video Selfview Default Mode
xConfiguration Video Selfview Default FullscreenMode
.............................................................................................................................. 84
............................................................................................................81
.................................................................................................................. 86
.........................................................................................79
.........................................................................................79
.......................................................................................... 80
................................................................................................... 80
............................................................................. 80
................................................................................................ 80
........................................................................... 81
.......................................................................................... 81
.......................................................................... 81
.................................................................................82
..................................................................................82
..................................................................82
..............................................................82
............................................................................... 83
............................................................................. 83
.................................................................................... 83
..................................................................................................84
..........................................................84
....................................................84
..................................................................84
....................................................................................85
..............................................................85
..................................................................................... 86
............................................................................... 86
.............................................................................87
......................................................................87
.........................................................................87
............................................................................................87
........................................................................... 88
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 41
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Video Selfview Default OnMonitorRole ............................................................................. 88
xConfiguration Video Selfview Default PIPPosition
xConfiguration Video Selfview OnCall Mode
................................................................................... 88
............................................................................................ 89
xConfiguration Video Selfview OnCall Duration
Audio commands
.................................................................................................................................. 95
........................................................................................ 89
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 42
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Audio configuration
xConfiguration Audio DefaultVolume
Define the default volume for the speakers. The volume is set to this value when you switch on
or restart the video system. Use the controls on the video system to change the volume while it
is running. You may also use API commands (xCommand Audio Volume) to change the volume
while the video system is running, and to reset to default value.
Requires user role: ADMIN, INTEGRATOR, USER
Default value: 50
USAGE:
xConfiguration Aud io D efau ltVolu me: Defau ltVolu m e
where
Defau ltVolu m e
Select a value between 1 and 100. This corresponds to the dB range from -34.5 dB to
15 dB, in steps of 0.5 dB. If set to 0 the audio is switched off.
xConfiguration Audio Microphones Mute Enabled
Define the microphone mute behaviour on the video system.
Requires user role: ADMIN, INTEGRATOR
Default value: True
USAGE:
xConfiguration Aud io M icrophones Mute Ena bled: Enabled
where
Enabled
True: Muting of audio is always available.
InCallOnly: Muting of audio is only available when the device is in a call. When Idle it is
not possible to mute the microphone. This is useful when an external telephone service/
audio system is connected via the codec and is to be available when the codec is not
in a call. When set to InCallOnly this will prevent the audio-system from being muted by
mistake.
: Integer (0..100)
: True/InCallOnly
xConfiguration Audio SoundsAndAlerts RingTone
Define which ringtone to use for incoming calls.
Requires user role: ADMIN, INTEGRATOR, USER
Default value: Sunrise
USAGE:
xConfiguration Aud io SoundsAndAlerts RingTo n e: RingTone
where
RingTone
Calculation/Mellow/Ringer
: Sunrise/Mischief/Ripples/Reflections/Vibes/Delight/Evolve/Playful/Ascent/
Select a ringtone from the list.
xConfiguration Audio SoundsAndAlerts RingVolume
Define the ring volume for incoming calls.
Requires user role: ADMIN, INTEGRATOR, USER
Default value: 50
USAGE:
xConfiguration Aud io SoundsAndAlerts RingVolu m e: Rin gVolu m e
where
RingVolume
: Integer (0..100)
The value goes in steps of 5 from 0 to 100 (from -34.5 dB to 15 dB). Volume 0 = Off.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 43
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Audio Input MicrophoneMode
This setting applies only to DX80.
The DX80 has microphones in both legs. If you set the microphone mode to Focused, the
microphones can be combined to focus sound sensitivity. As a result, the noise in the room is
suppressed, and you can be heard better when sitting right in front of the video system. The
voice of people not sitting right in front of the system will be suppressed.
If you set the microphone mode to Wide, the system behaves like any other system. The voice
of people sitting beside you will be heard, and also more noise from the room.
We recommend that you use Focused mode when you are the only speaker. Use Wide mode
when several speakers are in front of the system.
Requires user role: ADMIN, INTEGRATOR
Default value: Wide
USAGE:
xConfiguration Aud io Input MicrophoneMode: Micro ph on eMo de
where
MicrophoneM ode
Focused: Focused sound sensitivity, suppressing sound from sources that are not right
in front of the video system.
Wide: Default microphone operation with normal sound sensitivity.
: Focused/Wide
xConfiguration Audio Ultrasound MaxVolume
This setting applies to the Intelligent Proximity feature. Set the maximum volume of the ultra-
sound pairing message.
Requires user role: ADMIN, INTEGRATOR
Default value: DX80: 70 DX70: 60
USAGE:
xConfiguration Aud io Ultrasound M a xVolu m e: MaxVolume
where
Ma xVolu m e
: DX80: Integer (0..90) DX70: Integer (0..60)
Select a value in the specified range. If set to 0, the ultrasound is switched off.
Conference configuration
xConfiguration Conference AutoAnswer Mode
Define the auto answer mode. Use the Conference AutoAnswer Delay setting if you want
the system to wait a number of seconds before answering the call, and use the Conference
AutoAnswer Mute setting if you want your microphone to be muted when the call is answered.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration Conference AutoAnswer M od e: Mode
where
Mode
: Off/On
Off: You must answer incomming calls manually by tapping Answer.
On: The system automatically answers incoming calls, except if you are already in a
call. You must always answer or decline incoming calls manually when you are already
engaged in a call.
xConfiguration Conference AutoAnswer Mute
Define if the microphone shall be muted when an incoming call is automatically answered.
Requires that AutoAnswer Mode is switched on.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration Conference AutoAnswer M ute: Mute
where
Mute
: Off/On
Off: The incoming call will not be muted.
On: The incoming call will be muted when automatically answered.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 44
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Conference AutoAnswer Delay
Define how long (in seconds) an incoming call has to wait before it is answered automatically by
the system. Requires that AutoAnswer Mode is switched on.
Requires user role: ADMIN
Default value: 0
USAGE:
xConfiguration Conference AutoAnswer Delay: Delay
where
Delay
: Integer (0..50)
The auto answer delay (seconds).
xConfiguration Conference DefaultCall Protocol
Define the Default Call Protocol to be used when placing calls from the system.
Requires user role: ADMIN
Default value: Auto
USAGE:
xConfiguration Conference DefaultCall Pro to c ol: Protocol
where
Protocol
: Auto/H320/H323/Sip/Spark
Auto: Enables auto-selection of the call protocol based on which protocols are available.
If multiple protocols are available, the order of priority is: 1) SIP; 2) H323. If the system
cannot register, the auto-selection chooses H323.
H320: Not supported.
H323: All calls are set up as H.323 calls.
Sip: All calls are set up as SIP calls.
Spark: Reserved for Spark registered systems. Do not use.
xConfiguration Conference DefaultCall Rate
Define the Default Call Rate to be used when placing calls from the system.
Requires user role: ADMIN, INTEGRATOR
Default value: 3072
USAGE:
xConfiguration Conference DefaultCall Rat e: Rate
where
Rat e
: Integer (64..3072)
The default call rate (kbps).
xConfiguration Conference DoNotDisturb DefaultTimeout
This setting determines the default duration of a Do Not Disturb session, i.e. the period when
incoming calls are rejected and registered as missed calls. The session can be terminated
earlier by using the user interface. The default value is 60 minutes.
Requires user role: ADMIN, INTEGRATOR
Default value: 60
USAGE:
xConfiguration Conference DoNotDisturb DefaultTimeout: De fa ultTi m eo ut
where
Defau ltTime o ut
The number of minutes (maximum 1440 minutes = 24 hours) before the Do Not Disturb
session times out automatically.
: Integer (1..1440)
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 45
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Conference Encryption Mode
Define the conference encryption mode. A padlock with the text "Encryption On" or
"Encryption Off" displays on screen for a few seconds when the conference starts.
NOTE: If the Encr yption Option Key is not installed on the video system, the encryption mode is
always Off.
Requires user role: ADMIN
Default value: BestEffort
USAGE:
xConfiguration Conference Encry ption Mode: Mode
where
Mode
: Off/On/BestEffort
Off: The system will not use encryption.
On: The system will only allow calls that are encrypted.
BestEffort: The system will use encryption whenever possible.
> In Point to point calls: If the far end system supports encryption (AES-128), the call will
be encrypted. If not, the call will proceed without encryption.
> In MultiSite calls: In order to have encrypted MultiSite conferences, all sites must
support encryption. If not, the conference will be unencrypted.
xConfiguration Conference FarEndControl Mode
Lets you decide if the remote side (far end) should be allowed to select your video sources and
control your local camera (pan, tilt, zoom).
Requires user role: ADMIN
Default value: On
xConfiguration Conference MaxReceiveCallRate
Define the maximum receive bit rate to be used when placing or receiving calls. Note that this
is the maximum bit rate for each individual call; use the Conference MaxTotalReceiveCallRate
setting to set the aggregated maximum for all simultaneous active calls.
Requires user role: ADMIN
Default value: 3072
USAGE:
xConfiguration Conference MaxReceiveCallRate: MaxReceiveCallRate
where
MaxReceiveCallRate
The maximum receive call rate (kbps).
: Integer (64..3072)
xConfiguration Conference MaxTransmitCallRate
Define the maximum transmit bit rate to be used when placing or receiving calls. Note that this
is the maximum bit rate for each individual call; use the Conference MaxTotalTransmitCallRate
setting to set the aggregated maximum for all simultaneous active calls.
Requires user role: ADMIN
Default value: 3072
USAGE:
xConfiguration Conference MaxTransmitCallRate: MaxTransmitCallRate
where
MaxTransmitCallRate
The maximum transmitt call rate (kbps).
: Integer (64..3072)
USAGE:
xConfiguration Conference FarEndControl Mode: Mode
where
Mode
: Off/On
Off: The far end is not allowed to select your video sources or to control your local
camera (pan, tilt, zoom).
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.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 46
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Conference MaxTotalReceiveCallRate
Define the maximum overall receive bit rate allowed. This product does not support multiple
simultaneous calls, so the total receive call rate will be the same as the receive bit rate for one
call (ref. Conference MaxReceiveCallRate setting).
Requires user role: ADMIN
Default value: 3072
USAGE:
xConfiguration Conference MaxTotalReceiveCallRate: MaxTotalReceiveCallRate
where
MaxTotalReceiveCallRate
The maximum receive call rate (kbps).
: Integer (64..3072)
xConfiguration Conference MaxTotalTransmitCallRate
Define the maximum overall transmit bit rate allowed. This product does not support multiple
simultaneous calls, so the total transmit call rate will be the same as the transmit bit rate for one
call (ref. Conference MaxTransmitCallRate setting).
Requires user role: ADMIN
Default value: 3072
USAGE:
xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate
where
MaxTotalTransmitCallRate
The maximum transmit call rate (kbps).
: Integer (64..3072)
H323 configuration
xConfiguration H323 Authentication Mode
Define the authenticatin mode for the H.323 profile.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration H323 Authentication M o d e: Mode
where
Mode
: Off/On
Off: The system will not try to authenticate itself to a H.323 Gatekeeper, but will still try
a normal registration.
On: If an H.323 Gatekeeper indicates that it requires authentication, the system will try
to authenticate itself to the gatekeeper. Requires the H323 Authentication LoginName
and H323 Authentication Password settings to be defined on both the codec and the
Gatekeeper.
xConfiguration H323 Authentication LoginName
The system sends the H323 Authentication Login Name and the H323 Authentication Password
to an H.323 Gatekeeper for authentication. The authentication is a one way authentication from
the codec to the H.323 Gatekeeper, i.e. the system is authenticated to the gatekeeper. If the
H.323 Gatekeeper indicates that no authentication is required, the system will still try to register.
Requires the H.323 Authentication Mode to be enabled.
Requires user role: ADMIN
Default value: ""
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
USAGE:
xConfiguration H323 Authentication Lo gin Na m e: "LoginName"
where
LoginNa me
: String (0, 50)
The authentication login name.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 47
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration H323 Authentication Password
The system sends the H323 Authentication Login Name and the H323 Authentication Password
to an H.323 Gatekeeper for authentication. The authentication is a one way authentication from
the codec to the H.323 Gatekeeper, i.e. the system is authenticated to the gatekeeper. If the
H.323 Gatekeeper indicates that no authentication is required, the system will still try to register.
Requires the H.323 Authentication Mode to be enabled.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration H323 Authentication Password: "Password"
where
Password
: String (0, 50)
The authentication password.
xConfiguration H323 CallSetup Mode
Defines whether to use a Gatekeeper or Direct calling when establishing H.323 calls.
Direct H.323 calls can be made also when H323 CallSetup Mode is set to Gatekeeper.
Requires user role: ADMIN
Default value: Gatekeeper
USAGE:
xConfiguration H323 CallSetup Mod e: Mode
where
Mode
: Direct/Gatekeeper
Direct: You can only make an H.323 call by dialing an IP address directly.
Gatekeeper: The system uses a Gatekeeper to make an H.323 call. When choosing this
option, the H323 Gatekeeper Address must also be configured.
xConfiguration H323 Encryption KeySize
Define the minimum or maximum key size for the Diffie-Hellman key exchange method, which
is used when establishing the Advanced Encryption Standard (AES) encryption key.
Requires user role: ADMIN
Default value: Min1024bit
USAGE:
xConfiguration H323 Encry ption K eySize: KeySize
where
KeySize
: Min1024bit/Max1024bit/Min2048bit
Min1024bit: The minimum size is 1024 bit.
Max1024bit: The maximum size is 1024 bit.
Min2048bit: The minimum size is 2048 bit.
xConfiguration H323 Gatekeeper Address
Define the IP address of the Gatekeeper. Requires H323 CallSetup Mode to be set to
Gatekeeper.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration H323 Gatekeeper A d dress: "Address"
where
Address
: String (0, 255)
A valid IPv4 address, IPv6 address or DNS name.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 48
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration H323 H323Alias E164
The H.323 Alias E.164 defines the address of the system, according to the numbering plan
implemented in the H.323 Gatekeeper. The E.164 alias is equivalent to a telephone number,
sometimes combined with access codes.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration H323 H323A lias E164: "E164"
where
E16 4
: String (0, 30)
The H.323 Alias E.164 address. Valid characters are 0-9, * and #.
xConfiguration H323 H323Alias ID
Define the H.323 Alias ID, which is used to address the system on a H.323 Gatekeeper and will
be displayed in the call lists.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration H323 H323A lias ID: "ID"
where
ID
: String (0, 49)
The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID"
xConfiguration H323 NAT Mode
The firewall traversal technology creates a secure path through the firewall barrier, and enables
proper exchange of audio/video data when connected to an external video conferencing
system (when the IP traffic goes through a NAT router). NOTE: NAT does not work in conjunction with gatekeepers.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration H323 NAT M o d e: Mode
where
Mode
: Auto/Off/On
Auto: The system will determine if the H323 NAT Address or the real IP address should
be used in signaling. This makes it possible to place calls to endpoints on the LAN as
well as endpoints on the WAN. If the H323 NAT Address is wrong or not set, the real IP
address will be used.
Off: The system will signal the real IP address.
On: The system will signal the configured H323 NAT Address instead of its real IP
address in Q.931 and H.245. The NAT server address will be shown in the startup-
menu as: "My IP Address: 10.0.2.1". If the H323 NAT Address is wrong or not set, H.323
calls cannot be set up.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 49
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration H323 NAT Address
Define the external/global IP address to the router with NAT support. Packets sent to the
router will then be routed to the system. Note that NAT cannot be used when registered to a
gatekeeper.
In the router, the following ports must be routed to the system's IP address:
* Port 1720
* Port 5555-6555
* Port 2326-2487
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration H323 NAT A d d ress: "Address"
where
Address
: String (0, 64)
A valid IPv4 address or IPv6 address.
Macros configuration
xConfiguration Macros Mode
Macros allow you to write snippets of JavaScript code that can automate parts of your video
endpoint, thus creating custom behavior. Use of macros is disabled by default, but the first
time you open the Macro Editor you will be asked whether to enable use of macros on the
codec. Use this setting when you want to manually enable, or to permanently disable the use
of macros on the codec. You can disable the use of macros within the Macro Editor. But this
will not permanently disable macros from running, because ever y time the codec is reset the
macros will be re-enabled automatically.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration Macros Mode: Mode
where
Mode
: Off/On
Off: Permanently disable the use of macros on this video system.
On: Enable the use of macros on this video system.
xConfiguration Macros AutoStart
All the macros run in a single process on the video endpoint, called the macro runtime. It should
be running by default, but you can choose to stop and start it manually. If you restart the video
system, the runtime will automatically start again if auto start is enabled.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration Macros AutoStart: AutoStart
where
AutoStar t
: Off/On
Off: The macro runtime will not start automatically after a restart of the video system.
On: The macro runtime will start automatically after a restart of the video system.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 50
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Network configuration
xConfiguration Network [1] DNS Domain Name
The DNS Domain Name is the default domain name suffix which is added to unqualified names.
Example: If the DNS Domain Name is "company.com" and the name to lookup is
"MyVideoSystem", this will result in the DNS lookup "MyVideoSystem.company.com".
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n DNS Domain Na me: "Name"
where
n
: Index that identifies the network. Range: 1..1
Name
: String (0, 64)
The DNS domain name.
xConfiguration Network [1] DNS Server [1..3] Address
Define the network addresses for DNS servers. Up to three addresses may be specified. If the
network addresses are unknown, contact your administrator or Internet Service Provider.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n DNS Server m A d dress: "Address"
where
n
: Index that identifies the network. Range: 1..1
m
: Index that identifies the DNS server. Maximum three DNS servers are allowed. Range: 1..3
Address
: String (0, 64)
A valid IPv4 address or IPv6 address.
xConfiguration Network [1] IEEE8021X Mode
The system can be connected to an IEEE 802.1X LAN network, with a port-based network
access control that is used to provide authenticated network access for Ethernet networks.
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration Network n IEEE8021X Mo d e: Mode
where
n
: Index that identifies the network. Range: 1..1
Mode
: Off/On
Off: The 802.1X authentication is disabled (default).
On: The 802.1X authentication is enabled.
xConfiguration Network [1] IEEE8021X TlsVerify
Verification of the server-side certificate of an IEEE802.1x connection against the certificates in
the local CA-list when TLS is used. The CA-list must be uploaded to the video system. This can
be done from the web interface.
This setting takes effect only when Network [1] IEEE8021X Eap Tls is enabled (On).
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration Network n IEEE8021X TlsVerify: TlsVerif y
where
n
: Index that identifies the network. Range: 1..1
TlsVerify
: Off/On
Off: When set to Off, TLS connections are allowed without verifying the server-side
X.509 certificate against the local CA-list. This should typically be selected if no CA-list
has been uploaded to the codec.
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.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 51
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IEEE8021X UseClientCertificate
Authentication using a private key/certificate pair during an IEEE802.1x connection. The authen-
tication X.509 certificate must be uploaded to the video system. This can be done from the
web interface.
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration Network n IEEE8021X UseClientCertificate: UseClientCertificate
where
n
: Index that identifies the network. Range: 1..1
UseClientCertificate
Off: When set to Off client-side authentication is not used (only server-side).
On: When set to On the client (video system) will perform a mutual authentication TLS
handshake with the server.
: Off/On
xConfiguration Network [1] IEEE8021X Identity
Define the user name for 802.1X authentication.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IEEE8021X Identity: "Id e nt ity"
where
n
: Index that identifies the network. Range: 1..1
Ide ntity
: String (0, 64)
The user name for 802.1X authentication.
xConfiguration Network [1] IEEE8021X Password
Define the password for 802.1X authentication.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IEEE8021X Password: "Password"
where
n
: Index that identifies the network. Range: 1..1
Password
: String (0, 50)
The password for 802.1X authentication.
xConfiguration Network [1] IEEE8021X AnonymousIdentity
The 802.1X Anonymous ID string is to be used as unencrypted identity with EAP (Extensible
Authentication Protocol) types that support different tunneled identity, like EAP-PEAP and
EAP-TTLS. If set, the anonymous ID will be used for the initial (unencrypted) EAP Identity
Request.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IEEE8021X AnonymousIde ntity: "AnonymousIdentity"
where
n
: Index that identifies the network. Range: 1..1
AnonymousIdentity
The 802.1X Anonymous ID string.
: String (0, 64)
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 52
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IEEE8021X Eap Md5
Define the Md5 (Message-Digest Algorithm 5) mode. This is a Challenge Handshake
Authentication Protocol that relies on a shared secret. Md5 is a Weak security.
Requires user role: ADMIN, USER
Default value: On
USAGE:
xConfiguration Network n IEEE8021X Eap Md5: Md5
where
n
: Index that identifies the network. Range: 1..1
Md5
: Off/On
Off: The EAP-MD5 protocol is disabled.
On: The EAP-MD5 protocol is enabled (default).
xConfiguration Network [1] IEEE8021X Eap Ttls
Define the TTLS (Tunneled Transport Layer Security) mode. Authenticates LAN clients without
the need for client certificates. Developed by Funk Software and Certicom. Usually supported
by Agere Systems, Proxim and Avaya.
Requires user role: ADMIN, USER
Default value: On
USAGE:
xConfiguration Network n IEEE8021X Eap Ttls: Ttls
where
n
: Index that identifies the network. Range: 1..1
Ttls
: Off/On
Off: The EAP-TTLS protocol is disabled.
On: The EAP-TTLS protocol is enabled (default).
xConfiguration Network [1] IEEE8021X Eap Tls
Enable or disable the use of EAP-TLS (Transport Layer Security) for IEEE802.1x connections. The EAP-TLS protocol, defined in RFC 5216, is considered one of the most secure EAP
standards. LAN clients are authenticated using client certificates.
Requires user role: ADMIN, USER
Default value: On
USAGE:
xConfiguration Network n IEEE8021X Eap Tls: Tls
where
n
: Index that identifies the network. Range: 1..1
Tls
: Off/On
Off: The EAP-TLS protocol is disabled.
On: The EAP-TLS protocol is enabled (default).
xConfiguration Network [1] IEEE8021X Eap Peap
Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN
clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security.
Requires user role: ADMIN, USER
Default value: On
USAGE:
xConfiguration Network n IEEE8021X Eap Pe ap: Peap
where
n
: Index that identifies the network. Range: 1..1
Peap
: Off/On
Off: The EAP-PEAP protocol is disabled.
On: The EAP-PEAP protocol is enabled (default).
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 53
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IPStack
Select if the system should use IPv4, IPv6, or dual IP stack, on the network interface. NOTE:
After changing this setting you may have to wait up to 30 seconds before it takes effect.
Requires user role: ADMIN, USER
Default value: Dual
USAGE:
xConfiguration Network n IPSt ack: IPSt ac k
where
n
: Index that identifies the network. Range: 1..1
IPSt ac k
: Dual/IPv4/IPv6
Dual: When set to Dual, the network interface can operate on both IP versions at the
same time, and can have both an IPv4 and an IPv6 address at the same time.
IPv4: When set to IPv4, the system will use IPv4 on the network interface.
IPv6: When set to IPv6, the system will use IPv6 on the network interface.
xConfiguration Network [1] IPv4 Assignment
Define how the system will obtain its IPv4 address, subnet mask and gateway address. This
setting applies only to systems on IPv4 networks.
Requires user role: ADMIN, USER
Default value: DHCP
USAGE:
xConfiguration Network n IP v4 Assig nment: A ss ig n m ent
where
n
: Index that identifies the network. Range: 1..1
Assignm e nt
: Static/DHCP
Static: The addresses must be configured manually using the Network IPv4 Address,
Network IPv4 Gateway and Network IPv4 SubnetMask settings (static addresses).
DHCP: The system addresses are automatically assigned by the DHCP server.
xConfiguration Network [1] IPv4 Address
Define the static IPv4 network address for the system. Applicable only when Network IPv4
Assignment is set to Static.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IP v4 Add r e s s: "Address"
where
n
: Index that identifies the network. Range: 1..1
Address
: String (0, 64)
A valid IPv4 address.
xConfiguration Network [1] IPv4 Gateway
Define the IPv4 network gateway address. Applicable only when the Network IPv4 Assignment
is set to Static.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IP v4 Gateway: "Gateway "
where
n
: Index that identifies the network. Range: 1..1
Gate way
: String (0, 64)
A valid IPv4 address.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 54
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IPv4 SubnetMask
Define the IPv4 network subnet mask. Applicable only when the Network IPv4 Assignment is
set to Static.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IP v4 Su bnetMask: "SubnetMask "
where
n
: Index that identifies the network. Range: 1..1
Sub netMask
: String (0, 64)
A valid IPv4 address.
xConfiguration Network [1] IPv6 Assignment
Define how the system will obtain its IPv6 address and the default gateway address. This
setting applies only to systems on IPv6 networks.
Requires user role: ADMIN, USER
Default value: Autoconf
USAGE:
xConfiguration Network n IP v6 Assign m e nt: Assignme nt
where
n
: Index that identifies the network. Range: 1..1
Assignm e nt
: Static/DHCPv6/Autoconf
Static: The codec and gateway IP addresses must be configured manually using the
Network IPv6 Address and Network IPv6 Gateway settings. The options, for example
NTP and DNS server addresses, must either be set manually or obtained from a
DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to
use.
DHCPv6: All IPv6 addresses, including options, will be obtained from a DHCPv6 server.
See RFC 3315 for a detailed description. The Network IPv6 DHCPOptions setting will
be ignored.
Autoconf: Enable IPv6 stateless autoconfiguration of the IPv6 network interface. See
RFC 4862 for a detailed description. The options, for example NTP and DNS server
addresses, must either be set manually or obtained from a DHCPv6 server. The
Network IPv6 DHCPOptions setting determines which method to use.
xConfiguration Network [1] IPv6 Address
Define the static IPv6 network address for the system. Applicable only when the Network IPv6
Assignment is set to Static.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IP v6 Ad d re s s: "Address"
where
n
: Index that identifies the network. Range: 1..1
Address
: String (0, 64)
A valid IPv6 address including a network mask. Example: 2001:DB8::/48
xConfiguration Network [1] IPv6 Gateway
Define the IPv6 network gateway address. This setting is only applicable when the Network
IPv6 Assignment is set to Static.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n IP v6 Gateway: "Gateway"
where
n
: Index that identifies the network. Range: 1..1
Gate way
: String (0, 64)
A valid IPv6 address.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 55
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] IPv6 DHCPOptions
Retrieve a set of DHCP options, for example NTP and DNS server addresses, from a DHCPv6
server.
Requires user role: ADMIN, USER
Default value: On
USAGE:
xConfiguration Network n IP v6 DHCPOptions: DHCPOptions
where
n
: Index that identifies the network. Range: 1..1
DHCPOptions
: Off/On
Off: Disable the retrieval of DHCP options from a DHCPv6 server.
On: Enable the retrieval of a selected set of DHCP options from a DHCPv6 server.
xConfiguration Network [1] MTU
Define the Ethernet MTU (Maximum Transmission Unit) size. The MTU size must be supported
by your network infrastructure. The minimum size is 576 for IPv4 and 1280 for IPv6.
Requires user role: ADMIN, USER
Default value: 1500
USAGE:
xConfiguration Network n M TU: MTU
where
n
: Index that identifies the network. Range: 1..1
MTU
: Integer (576..1500)
Set a value for the MTU (bytes).
xConfiguration Network [1] QoS Mode
The QoS (Quality of Service) is a method which handles the priority of audio, video and data in
the network. The QoS settings must be supported by the infrastructure. Diffserv (Differentiated
Services) is a computer networking architecture that specifies a simple, scalable and coarsegrained mechanism for classifying, managing network traffic and providing QoS priorities on
modern IP networks.
Requires user role: ADMIN, USER
Default value: Diffserv
USAGE:
xConfiguration Network n QoS Mode: Mode
where
n
: Index that identifies the network. Range: 1..1
Mode
: Off/Diffserv
Off: No QoS method is used.
Diffserv: When you set the QoS Mode to Diffserv, the Network QoS Diffserv Audio,
Network QoS Diffserv Video, Network QoS Diffserv Data, Network QoS Diffser v
Signalling, Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are
used to prioritize packets.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 56
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] QoS Diffserv Audio
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority Audio packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the prior-
ity. The recommended class for Audio is CS4, which equals the decimal value 32. If in doubt,
contact your network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv Audio: Aud io
where
n
: Index that identifies the network. Range: 1..1
Audio
: Integer (0..63)
Set the priority of the audio packets in the IP network - the higher the number, the
higher the priority. The default value is 0 (best effort).
xConfiguration Network [1] QoS Diffserv Video
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority Video packets should have in the IP network. The packets on the
presentation channel (shared content) are also in the Video packet category. The priority for
the packets ranges from 0 to 63 - the higher the number, the higher the priority. The recommended class for Video is CS4, which equals the decimal value 32. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv Video: Vide o
where
n
: Index that identifies the network. Range: 1..1
Video
: Integer (0..63)
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).
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 57
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] QoS Diffserv Data
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority Data packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the prior-
ity. The recommended value for Data is 0, which means best effort. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv Data: Data
where
n
: Index that identifies the network. Range: 1..1
Data
: Integer (0..63)
Set the priority of the data packets in the IP network - the higher the number, the higher
the priority. The default value is 0 (best effort).
xConfiguration Network [1] QoS Diffserv Signalling
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority Signalling packets that are deemed critical (time-sensitive) for the real-
time operation should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority.
The recommended class for Signalling is CS3, which equals the decimal value 24. If in doubt,
contact your network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv Sig n all ing: Sig nalling
where
n
: Index that identifies the network. Range: 1..1
Signalling
: Integer (0..63)
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).
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 58
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] QoS Diffserv ICMPv6
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority ICMPv6 packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the priority.
The recommended value for ICMPv6 is 0, which means best effort. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv IC M Pv6: IC MP v6
where
n
: Index that identifies the network. Range: 1..1
ICMP v6
: Integer (0..63)
Set the priority of the ICMPv6 packets in the IP network - the higher the number, the
higher the priority. The default value is 0 (best effort).
xConfiguration Network [1] QoS Diffserv NTP
This setting will only take effect if Network QoS Mode is set to Diffserv.
Define which priority NTP packets should have in the IP network.
The priority for the packets ranges from 0 to 63 - the higher the number, the higher the prior-
ity. The recommended value for NTP is 0, which means best effort. If in doubt, contact your
network administrator.
The priority set here might be overridden when packets are leaving the network controlled by
the local network administrator.
Requires user role: ADMIN, USER
Default value: 0
USAGE:
xConfiguration Network n QoS Diffserv NTP: NTP
where
n
: Index that identifies the network. Range: 1..1
NTP
: Integer (0..63)
Set the priority of the NTP packets in the IP network - the higher the number, the higher
the priority. The default value is 0 (best effort).
xConfiguration Network [1] RemoteAccess Allow
Define which IP addresses (IPv4/IPv6) are allowed for remote access to the codec from SSH/
Telnet/HTTP/HTTPS. Multiple IP addresses are separated by a white space.
A network mask (IP range) is specified by <ip address>/N, where N is 1-32 for IPv4, and N is
1-128 for IPv6. The /N is a common indication of a network mask where the first N bits are set.
Thus 192.168.0.0/24 would match any address starting with 192.168.0, since these are the first
24 bits in the address.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Network n RemoteAccess Allow: "Allow "
where
n
: Index that identifies the network. Range: 1..1
Allow
: String (0, 255)
A valid IPv4 address or IPv6 address.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 59
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Network [1] Speed
Define the Ethernet link speed. We recommend not to change from the default value, which
negotiates with the network to set the speed automatically. If you do not use autonegotiation, make sure that the speed you choose is supported by the closest switch in your network
infrastructure.
Requires user role: ADMIN, USER
Default value: Auto
USAGE:
xConfiguration Network n Spee d: Speed
where
n
: Index that identifies the network. Range: 1..1
Speed
: Aut o/10h alf/10f ull/100h alf/100f ull/1000 full
Auto: Autonegotiate link speed.
10half: Force link to 10 Mbps half-duplex.
10full: Force link to 10 Mbps full-duplex.
100half: Force link to 100 Mbps half-duplex.
100full: Force link to 100 Mbps full-duplex.
1000full: Force link to 1 Gbps full-duplex.
xConfiguration Network [1] VLAN Voice Mode
Define the VLAN voice mode. The VLAN Voice Mode will be set to Auto automatically if you
have Cisco UCM (Cisco Unified Communications Manager) as provisioning infrastructure. Note
that Auto mode will NOT work if the NetworkServices CDP Mode setting is Off.
Requires user role: ADMIN, USER
Default value: Auto
USAGE:
xConfiguration Network n VLAN Voice Mode: Mode
where
n
: Index that identifies the network. Range: 1..1
Mode
: Auto/Manual/Off
Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN.
If CDP is not available, VLAN is not enabled.
Manual: The VLAN ID is set manually using the Network VLAN Voice VlanId setting. If
CDP is available, the manually set value will be overruled by the value assigned by CDP.
Off: VLAN is not enabled.
xConfiguration Network [1] VLAN Voice VlanId
Define the VLAN voice ID. This setting will only take effect if Network VLAN Voice Mode is set
to Manual.
Requires user role: ADMIN, USER
Default value: 1
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
USAGE:
xConfiguration Network n VLAN Voice VlanId: VlanId
where
n
: Index that identifies the network. Range: 1..1
VlanId
: Integer (1..4094)
Set the VLAN voice ID.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 60
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
NetworkPort configuration
xConfiguration NetworkPort [2] Mode
The video system has two network ports. The first network port is for connecting the video
system to Ethernet LAN. The second network port (also called the computer network port)
allows you to connect a computer to the Ethernet LAN via the video system. In this way, you
only need one network wall socket to support both the video system and the computer.
If the video system is used in a public environment we recommend that you disable this
network port, to prevent people from connecting a computer to your network through the video
system.
You have to restart the video system for any change to this setting to take effect.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration NetworkPort n M o d e: Mode
where
n
: Unique ID that identifies the network port Range: 2..2
Mode
: Off/On
Off: The computer network port is disabled.
On: The computer network port is available for use.
NetworkServices configuration
xConfiguration NetworkServices CDP Mode
Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the
endpoint report certain statistics and device identifiers to a CDP-enabled switch. If CDP is
disabled, the Network VLAN Voice Mode: Auto setting will not work.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration NetworkServices CDP M od e: Mode
where
Mode
: Off/On
Off: The CDP daemon is disabled.
On: The CDP daemon is enabled.
xConfiguration NetworkServices H323 Mode
Define whether the system should be able to place and receive H.323 calls or not.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration NetworkServices H323 M o d e: Mode
where
Mode
: Off/On
Off: Disable the possibility to place and receive H.323 calls.
On: Enable the possibility to place and receive H.323 calls (default).
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 61
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration NetworkServices HTTP Mode
Define whether or not to allow access to the video system using the HTTP or HTTPS (HTTP
Secure) protocols. Note that the video system's web interface use HTTP or HTTPS. If this
setting is switched Off, you cannot use the web interface.
If you need extra security (encryption and decryption of requests, and pages that are returned
by the web server), allow only HT TPS.
Requires user role: ADMIN
Default value: HTTP+HTTPS
USAGE:
xConfiguration NetworkServices HTTP Mode: Mode
where
Mode
: Off/HTTP+HTTPS/HTTPS
Off: Access to the video system not allowed via HTTP or HTTPS.
HTTP+HTTPS: Access to the video system allowed via both HTTP and HTTPS.
HTTPS: Access to the video system allowed via HTTPS, but not via HTTP.
xConfiguration NetworkServices HTTP Proxy Allowed
The HTTP Proxy Settings are available from the user interface when the system is provisioned
to Cisco Spark. The HT TP proxy settings makes it possible to onboard a video system behind a
HTTP proxy to Spark.
Requires user role: ADMIN, USER
Default value: True
xConfiguration NetworkServices HTTP Proxy LoginName
This is the user name part of the credentials for authentication towards the HTTP proxy.
Requires that the NetworkServices HTTP Proxy Mode is set to Manual.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration NetworkServices HTTP Proxy Lo gin Na m e: "LoginName"
where
LoginNa me
: String (0, 80)
The authentication login name.
xConfiguration NetworkServices HTTP Proxy Password
This is the password part of the credentials for authentication towards the HTTP proxy.
Requires that the NetworkServices HTTP Proxy Mode is set to Manual.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration NetworkServices HTTP Proxy Password: "Password"
where
Password
: String (0, 64)
The authentication password.
USAGE:
xConfiguration NetworkServices HTTP Proxy Allo wed: Allow ed
where
Allowed
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
: False/True
False: The HTTP proxy settings are not available from the Cisco Spark setup wizard.
True: The HTTP proxy settings are available from the Cisco Spark setup wizard.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 62
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration NetworkServices HTTP Proxy Mode
The HTTP proxy for Cisco Spark can be set up manually or turned off.
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration NetworkServices HTTP Proxy M o d e: Mode
where
Mode
: Manual/Off
Manual: Add the address of the proxy server in the NetworkServices HTTP Proxy URL
setting. Optionally, you can add the login name HTTP proxy login name and password
in the NetworkSer vices HTTP Proxy LoginName/Password settings.
Off: The HTTP proxy mode is turned off.
xConfiguration NetworkServices HTTP Proxy Url
Set the URL of the HTTP proxy server. Requires that the NetworkServices HTTP Proxy Mode is
set to Manual.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration NetworkServices HTTP Proxy Url: "Url"
where
Url
: String (0, 255)
The URL for the HTTP proxy server.
xConfiguration NetworkServices HTTPS Server MinimumTLSVersion
Set the lowest version of the TLS (Transport Layer Security) protocol that is allowed.
Requires user role: ADMIN
Default value: TLSv1.1
USAGE:
xConfiguration NetworkServices HTTPS Server M i ni m u m TLSVer sion: Minimu mTLSVersio n
where
Mini mumTLSVersion
TLSv1.1: Support of TLS version 1.1 or higher.
TLSv1.2: Support of TLS version 1.2 or higher.
: T LSv1.1/TLS v1. 2
xConfiguration NetworkServices HTTPS StrictTransportSecurity
The HTTP Strict Transport Security header lets a web site inform the browser that it should
never load the site using HTTP and should automatically convert all attempts to access the site
using HTTP to HTTPS requests instead.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration NetworkServices HTTPS StrictTransportSecurity:
StrictTransport Security
where
StrictTransport Security
Off: The HTTP strict transport security feature is disabled.
On: The HTTP strict transport security feature is enabled.
: Off/On
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 63
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration NetworkServices HTTPS VerifyServerCertificate
When the video system connects to an external HTTPS server (like a phone book server or an
external manager), this server will present a certificate to the video system to identify itself.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration NetworkServices HTTPS VerifyServerCertificate:
VerifyServerCertificate
where
VerifyServerCertificate
Off: Do not verify server certificates.
On: Requires the system to verify that the server certificate is signed by a trusted
Certificate Authority (CA). This requires that a list of trusted CAs are uploaded to the
system in advance.
: Off/On
xConfiguration NetworkServices HTTPS VerifyClientCertificate
When the video system connects to a HTTPS client (like a web browser), the client can be
asked to present a certificate to the video system to identify itself.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration NetworkServices HTTPS VerifyClientCertificate:
VerifyClientCertificate
where
VerifyClientCertificate
Off: Do not verify client certificates.
On: Requires the client to present a certificate that is signed by a trusted Certificate
Authority (CA). This requires that a list of trusted CAs are uploaded to the system in
advance.
: Off/On
xConfiguration NetworkServices NTP Mode
The Network Time Protocol (NTP) is used to synchronize the system's time and date to a refer-
ence time server. The time server will be queried regularly for time updates.
Requires user role: ADMIN
Default value: Auto
USAGE:
xConfiguration NetworkServices NTP Mode: Mode
where
Mode
: Auto/Manual/Off
Auto: The system will use an NTP server for time reference. As default, the server
address will be obtained from the network's DHCP server. If a DHCP server is not used,
or if the DHCP server does not provide an NTP server address, the NTP server address
that is specified in the NetworkServices NTP Server [n] Address setting will be used.
Manual: The system will use the NTP server that is specified in the NetworkServices
NTP Server [n] Address setting for time reference.
Off: The system will not use an NTP server. The NetworkServices NTP Ser ver [n]
Address setting will be ignored.
xConfiguration NetworkServices NTP Server [1..3] Address
The address of the NTP server that will be used when NetworkServices NTP Mode is set to
Manual, and when NetworkSer vices NTP Mode is set to Auto and no address is supplied by a
DHCP server.
Requires user role: ADMIN
Default value: 0.tandberg.pool.ntp.org
USAGE:
xConfiguration NetworkServices NTP Server n A d d ress: "Address"
where
n
: Unique ID that identifies the NTP server. Range: 1..3
Address
: String (0, 255)
A valid IPv4 address, IPv6 address or DNS name.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 64
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration NetworkServices SIP Mode
Define whether the system should be able to place and receive SIP calls or not.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration NetworkServices SIP Mod e: Mode
where
Mode
: Off/On
Off: Disable the possibility to place and receive SIP calls.
On: Enable the possibility to place and receive SIP calls (default).
xConfiguration NetworkServices SNMP Mode
SNMP (Simple Network Management Protocol) is used in network management systems to
monitor network-attached devices (routers, servers, switches, projectors, etc) for conditions
that warrant administrative attention. SNMP exposes management data in the form of variables
on the managed systems, which describe the system configuration. These variables can then
be queried (set to ReadOnly) and sometimes set (set to ReadWrite) by managing applications.
Requires user role: ADMIN
Default value: ReadOnly
USAGE:
xConfiguration NetworkServices SNMP Mod e: Mode
where
Mode
: Off/ReadOnly/ReadWrite
Off: Disable the SNMP network service.
ReadOnly: Enable the SNMP network service for queries only.
ReadWrite: Enable the SNMP network service for both queries and commands.
xConfiguration NetworkServices SNMP Host [1..3] Address
Define the address of up to three SNMP Managers.
The system's SNMP Agent (in the codec) responds to requests from SNMP Managers (a PC
program etc.), for example about system location and system contact. SNMP traps are not
supported.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration NetworkServices SNMP Host n A d d ress: "Address"
where
n
: Identifies the SNMP host. Maximum three SNMP hosts are allowed. Range: 1..3
Address
: String (0, 255)
A valid IPv4 address, IPv6 address or DNS name.
xConfiguration NetworkServices SNMP CommunityName
Define the name of the Network Services SNMP Community. SNMP Community names are
used to authenticate SNMP requests. SNMP requests must have a password (case sensitive)
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
same SNMP Community is configured there too. NOTE: The SNMP Community password is
case sensitive.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration NetworkServices SNMP Com munityNa me: "CommunityName"
where
CommunityName
The SNMP community name.
: String (0, 50)
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 65
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration NetworkServices SNMP SystemContact
Define the name of the Network Services SNMP System Contact.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration NetworkServices SNMP Sy stem Cont act: "SystemContact"
where
SystemContact
The name of the SNMP system contact.
: String (0, 50)
xConfiguration NetworkServices SNMP SystemLocation
Define the name of the Network Services SNMP System Location.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration NetworkServices SNMP SystemLocation: "SystemLocation"
where
SystemLocation
The name of the SNMP system location.
: String (0, 50)
xConfiguration NetworkServices SSH Mode
SSH (or Secure Shell) protocol can provide secure encrypted communication between the
codec and your local computer.
xConfiguration NetworkServices Telnet Mode
Telnet is a network protocol used on the Internet or Local Area Network (LAN) connections.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration NetworkServices Telnet M o d e: Mode
where
Mode
: Off/On
Off: The Telnet protocol is disabled. This is the factory setting.
On: The Telnet protocol is enabled.
xConfiguration NetworkServices WelcomeText
Choose which information the user should see when logging on to the codec through Telnet/
SSH.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration NetworkServices W elc o m eText: WelcomeText
where
WelcomeText
Off: The welcome text is: Login successful
On: The welcome text is: Welcome to <system name>; Software version; Software
release date; Login successful.
: Off/On
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration NetworkServices SSH M od e: Mode
where
Mode
: Off/On
Off: The SSH protocol is disabled.
On: The SSH protocol is enabled.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 66
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Peripherals configuration
xConfiguration Peripherals Profile ControlSystems
Define if a third-party control system, for example Crestron or AMX, is expected to be
connected to the video system. This information is used by the video system's diagnostics
service. If the number of connected control systems does not match this setting, the diagnostics service will report it as an inconsistency. Note that only one third-party control system is
supported.
If set to 1, the control system must send heart beats to the video system using xCommand
Peripherals Pair and HeartBeat commands. Failing to do so will cause the in-room control
extensions to show a warning that the video system has lost connectivity to the control system.
Requires user role: ADMIN, INTEGRATOR
Default value: NotSet
USAGE:
xConfiguration Peripherals Profile ControlSystems: ControlSystems
where
ControlSystems
1: One third-party control system should be connected to the video system.
NotSet: No check for a third-party control system is performed.
: 1/NotSet
Phonebook configuration
xConfiguration Phonebook Server [1] ID
Define a name for the external phone book.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration Phonebook Server n ID: "ID"
where
n
: Unique ID that identifies the phonebook server. Range: 1..1
ID
: String (0, 64)
The name for the external phone book.
xConfiguration Phonebook Server [1] Type
Select the phonebook server type.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration Phonebook Server n Ty p e: Type
where
n
: Unique ID that identifies the phonebook server. Range: 1..1
Type
: Off/CUCM/Spark/TMS/VCS
Off: Do not use a phonebook.
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.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 67
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Phonebook Server [1] URL
Define the address (URL) to the external phone book server.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration Phonebook Server n UR L: "URL"
where
n
: Unique ID that identifies the phonebook server. Range: 1..1
URL
: String (0, 255)
A valid address (URL) to the phone book server.
Provisioning configuration
xConfiguration Provisioning Connectivity
This setting controls how the device discovers whether it should request an internal or external
configuration from the provisioning server.
Requires user role: ADMIN, USER
Default value: Auto
USAGE:
xConfiguration Provisioning Connectivity: Connectivity
where
Connectivity
Internal: Request internal configuration.
External: Request external configuration.
Auto: Automatically discover using NAPTR queries whether internal or external configu-
rations should be requested. If the NAPTR responses have the "e" flag, external
configurations will be requested. Otherwise internal configurations will be requested.
: Internal/External/Auto
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 68
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Provisioning Mode
It is possible to configure a video system using a provisioning system (external manager). This
allows video conferencing network administrators to manage many video systems simultaneously. With this setting you choose which type of provisioning system to use. Provisioning
can also be switched off. Contact your provisioning system provider/representative for more
information.
Requires user role: ADMIN, USER
Default value: Auto
USAGE:
xConfiguration Provisioning M o d e: Mode
where
Mode
: Off/Auto/CUCM/Edge/Spark/TMS/VCS
Off: The video system is not configured by a provisioning system.
Auto: The provisioning server is automatically selected as set up in the DHCP server.
CUCM: Push configurations to the video system from CUCM (Cisco Unified
Communications Manager).
Edge: Push configurations to the video system from CUCM (Cisco Unified
Communications Manager). The system connects to CUCM via the Collaboration Edge
infrastructure. In order to register over Edge the encryption option key must be installed
on the video system.
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).
xConfiguration Provisioning LoginName
This is the username part of the credentials used to authenticate the video system with the
provisioning server. This setting must be used when required by the provisioning server.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning L o g i n Na m e: "LoginName"
where
LoginNa me
: String (0, 80)
A valid username.
xConfiguration Provisioning Password
This is the password part of the credentials used to authenticate the video system with the
provisioning server. This setting must be used when required by the provisioning server.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning Pass word: "Password"
where
Password
: String (0, 64)
A valid password.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 69
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Provisioning HttpMethod
Select the HTTP method to be used for the provisioning.
Requires user role: ADMIN, USER
Default value: POST
USAGE:
xConfiguration Provisioning HttpMethod: Http Metho d
where
HttpMethod
: G ET/PO ST
GET: Select GET when the provisioning server supports GET.
POST: Select POST when the provisioning server supports POST.
xConfiguration Provisioning ExternalManager Address
Define the IP Address or DNS name of the external manager / provisioning system.
If an External Manager Address (and Path) is configured, the system will send a message to this
address when starting up. When receiving this message the external manager / provisioning
system can return configurations/commands to the unit as a result.
When using CUCM or TMS provisioning, the DHCP server can be set up to provide the external
manager address automatically (DHCP Option 242 for TMS, and DHCP Option 150 for CUCM).
An address set in the Provisioning ExternalManager Address setting will override the address
provided by DHCP.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning ExternalManager Ad d ress: "Address"
where
Address
: String (0, 64)
A valid IPv4 address, IPv6 address or DNS name.
xConfiguration Provisioning ExternalManager AlternateAddress
Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager
(CUCM) and an alternate CUCM is available for redundancy. Define the address of the alternate
CUCM. If the main CUCM is not available, the endpoint will be provisioned by the alternate
CUCM. When the main CUCM is available again, the endpoint will be provisioned by this CUCM.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning ExternalManager AlternateAddress: "AlternateAddress"
where
AlternateAddress
A valid IPv4 address, IPv6 address or DNS name.
: String (0, 64)
xConfiguration Provisioning ExternalManager Protocol
Define whether to use the HTTP (unsecure communication) or HTTPS (secure communication)
protocol when sending requests to the external manager / provisioning system.
The selected protocol must be enabled in the NetworkServices HTTP Mode setting.
Requires user role: ADMIN, USER
Default value: HTTP
USAGE:
xConfiguration Provisioning ExternalManager Protocol: Protocol
where
Protocol
: HTTPS/HTTP
HTTPS: Send requests via HT TPS.
HTTP: Send requests via HTTP.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 70
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Provisioning ExternalManager Path
Define the Path to the external manager / provisioning system. This setting is required when
several management services reside on the same server, i.e. share the same External Manager
address.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning ExternalManager Pat h: "Path"
where
Path
: String (0, 255)
A valid path to the external manager or provisioning system.
xConfiguration Provisioning ExternalManager Domain
Define the SIP domain for the VCS provisioning server.
Requires user role: ADMIN, USER
Default value: ""
USAGE:
xConfiguration Provisioning ExternalManager Do m a i n: "Domain"
where
Domain
: String (0, 64)
A valid domain name.
Proximity configuration
xConfiguration Proximity Mode
Determine whether the video system will emit ultrasound pairing messages or not.
When the video system emits ultrasound, Proximity clients can detect that they are close to the
video system. In order to use a client, at least one of the Proximity services must be enabled
(refer to the Proximity Services settings). In general, Cisco recommends enabling all the
Proximity services.
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration Proximity Mode: Mode
where
Mode
: Off/On
Off: The video system does not emit ultrasound, and Proximity services cannot be used.
On: The video system emits ultrasound, and Proximity clients can detect that they are
close to the video system. Enabled Proximity services can be used.
xConfiguration Proximity Services CallControl
Enable or disable basic call control features on Proximity clients. When this setting is enabled,
you are able to control a call using a Proximity client (for example dial, mute, adjust volume and
hang up). This service is supported by mobile devices (iOS and Android). Proximity Mode must
be On for this setting to take any effect.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Requires user role: ADMIN, USER
Default value: Disabled
USAGE:
xConfiguration Proximity Services CallControl: CallCo ntr ol
where
Ca llCo nt rol
: Enabled/Disabled
Enabled: Call control from a Proximity client is enabled.
Disabled: Call control from a Proximity client is disabled.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 71
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Proximity Services ContentShare FromClients
Enable or disable content sharing from Proximity clients. When this setting is enabled, you can
share content from a Proximity client wirelessly on the video system, e.g. share your laptop
screen. This service is supported by laptops (OS X and Windows). Proximity Mode must be On
for this setting to take any effect.
Requires user role: ADMIN, USER
Default value: Enabled
USAGE:
xConfiguration Proximity Services ContentShare FromClients: FromClients
where
FromClients
: Enabled/Disabled
Enabled: Content sharing from a Proximity client is enabled.
Disabled: Content sharing from a Proximity client is disabled.
xConfiguration Proximity Services ContentShare ToClients
Enable or disable content sharing to Proximity clients. When enabled, Proximity clients will
receive the presentation from the video system. You can zoom in on details, view previous
content and take snapshots. This service is supported by mobile devices (iOS and Android).
Proximity Mode must be On for this setting to take any effect.
Requires user role: ADMIN, USER
Default value: Disabled
USAGE:
xConfiguration Proximity Services ContentShare ToClie n t s: ToClients
where
ToClients
: Enabled/Disabled
Enabled: Content sharing to a Proximity client is enabled.
Disabled: Content sharing to a Proximity client is disabled.
SerialPort configuration
xConfiguration SerialPort Mode
Enable/disable the serial port (connection via Micro USB to USB cable). The serial port uses
115200 bps, 8 data bits, no parity and 1 stop bit.
Requires user role: ADMIN, INTEGRATOR
Default value: On
USAGE:
xConfiguration SerialPort Mode: Mode
where
Mode
: Off/On
Off: Disable the serial port.
On: Enable the serial port.
xConfiguration SerialPort LoginRequired
Define if login shall be required when connecting to the serial port.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration SerialPort LoginRequired: LoginRequired
where
LoginRequir ed
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.
: Off/On
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 72
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
SIP configuration
xConfiguration SIP Authentication UserName
This is the user name part of the credentials used to authenticate towards the SIP proxy.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Authentication UserName: "UserNa me "
where
UserName
xConfiguration SIP Authentication Password
This is the password part of the credentials used to authenticate towards the SIP proxy.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Authentication Password: "Password"
where
Password
: String (0, 128)
A valid username.
: String (0, 128)
A valid password.
xConfiguration SIP DefaultTransport
Select the transport protocol to be used over the LAN.
Requires user role: ADMIN
Default value: Auto
USAGE:
xConfiguration SIP D efau ltTra ns p ort: Defau ltTra n s por t
where
Defau ltTra n spor t
TCP: The system will always use TCP as the default transport method.
UDP: The system will always use UDP as the default transport method.
Tls: The system will always use TLS as the default transport method. For TLS connec-
tions a SIP CA-list can be uploaded to the video system. If no such CA-list is available
on the system then anonymous Diffie Hellman will be used.
Auto: The system will try to connect using transport protocols in the following order:
T L S , TC P, U D P.
: TC P/U DP/Tls/Auto
xConfiguration SIP DisplayName
When configured the incoming call will report the display name instead of the SIP URI.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP DisplayNa me: "DisplayNa me"
where
Displa yNa me
The name to be displayed instead of the SIP URI.
: String (0, 550)
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 73
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration SIP Ice Mode
ICE (Interactive Connectivity Establishment, RFC 5245) is a NAT traversal solution that the video
systems can use to discover the optimized media path. Thus the shortest route for audio and
video is always secured between the video systems.
Requires user role: ADMIN
Default value: Auto
USAGE:
xConfiguration SIP Ic e Mod e: Mode
where
Mode
: Auto/Off/On
Auto: ICE is enabled if a TURN server is provided, otherwise ICE is disabled.
Off: ICE is disabled.
On: ICE is enabled.
xConfiguration SIP Ice DefaultCandidate
The ICE protocol needs some time to reach a conclusion about which media route to use (up to
the first 5 seconds of a call). During this period media for the video system will be sent to the
Default Candidate as defined in this setting.
Requires user role: ADMIN
Default value: Host
USAGE:
xConfiguration SIP Ic e DefaultCandidate: DefaultCandidate
where
DefaultCandidate
Host: Send media to the video system's private IP address.
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.
: Host/Rflx/Relay
xConfiguration SIP ListenPort
Turn on or off the listening for incoming connections on the SIP TCP/UDP ports. If turned off,
the endpoint will only be reachable through the SIP registrar (CUCM or VCS).
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration SIP ListenPort: ListenPort
where
ListenPort
: Off/On
Off: Listening for incoming connections on the SIP TCP/UDP ports is turned off.
On: Listening for incoming connections on the SIP TCP/UDP ports is turned on.
xConfiguration SIP Proxy [1..4] Address
The Proxy Address is the manually configured address for the outbound proxy. It is possible to
use a fully qualified domain name, or an IP address. The default port is 5060 for TCP and UDP
but another one can be provided.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Proxy n Ad d re s s: "Address"
where
n
: Index that identifies the proxy (maximum 4 proxys can be defined). Range: 1..4
Address
: String (0, 255)
A valid IPv4 address, IPv6 address or DNS name.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 74
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration SIP Turn Server
Define the address of the TURN (Traversal Using Relay NAT) server. It is used as a media relay
fallback and it is also used to discover the endpoint's own public IP address.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Turn Server: "Server"
where
Server
: String (0, 255)
The preferred format is DNS SRV record (e.g. _turn._udp.<domain>), or it can be a valid
IPv4 or IPv6 address.
xConfiguration SIP Turn UserName
Define the user name needed for accessing the TURN server.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Turn UserName: "UserName"
where
UserName
: String (0, 128)
A valid user name.
xConfiguration SIP URI
The SIP URI (Uniform Resource Identifier) is the address that is used to identify the video
system. The URI is registered and used by the SIP services to route inbound calls to the system.
The SIP URI syntax is defined in RFC 3261.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP U RI: "URI"
where
URI
: String (0, 255)
An address (URI) that is compliant with the SIP URI syntax.
xConfiguration SIP Turn Password
Define the password needed for accessing the TURN server.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SIP Turn Password: "Password"
where
Password
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
: String (0, 128)
A valid password.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 75
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Standby configuration
xConfiguration Standby Control
Define whether the system should go into standby mode or not.
Requires user role: ADMIN, INTEGRATOR
Default value: On
USAGE:
xConfiguration Standby Control: Contro l
where
Control
: Off/On
Off: The system will not enter standby mode.
On: The system will enter standby mode when the Standby Delay has timed out.
Requires the Standby Delay to be set to an appropriate value.
xConfiguration Standby Delay
Define how long (in minutes) the system shall be in idle mode before it goes into standby mode.
Requires the Standby Control to be enabled.
Requires user role: ADMIN, INTEGRATOR
Default value: 10
USAGE:
xConfiguration Standby Delay: Delay
where
Delay
: Integer (1..480)
Set the standby delay (minutes).
xConfiguration Standby WakeupOnMotionDetection
Automatic wake up on motion detection is a feature that will sense when a person walks into
the room. The feature is based on ultrasound detection, and the Proximity Mode setting must
be On to make the feature work.
Requires user role: ADMIN, INTEGRATOR
Default value: Off
USAGE:
xConfiguration Standby WakeupOnMotionDetection: Wakeu pOn MotionDetection
where
WakeupO nMotionDetectio n
Off: The wake up on motion detection is disabled.
On: When people walk into the room the system will automatically wake up from
standby (only applicable to DX80).
: Off/On
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 76
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
SystemUnit configuration
xConfiguration SystemUnit Name
Define the system name. The system name will be sent as the hostname in a DHCP request
and when the codec is acting as an SNMP Agent.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration SystemUnit N a me: "Name"
where
Name
: String (0, 50)
Define the system name.
Time configuration
xConfiguration Time TimeFormat
Define the time format.
Requires user role: ADMIN, USER
Default value: 24H
USAGE:
xConfiguration Tim e Ti meFormat: Tim eFormat
where
Tim eFor mat
xConfiguration Time DateFormat
Define the date format.
Requires user role: ADMIN, USER
Default value: DD_MM_YY
USAGE:
xConfiguration Tim e DateFor m at: DateFor m at
where
DateFor mat
: 24H/12H
24H: Set the time format to 24 hours.
12H: Set the time format to 12 hours (AM/PM).
: DD_MM_YY/MM_DD_YY/YY_MM_DD
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
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 77
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Time Zone
Define the time zone for the geographical location of the video system. The information in the
value space is from the tz database, also called the IANA Time Zone Database.
Requires user role: ADMIN, INTEGRATOR, USER
Default value: Etc/UTC
USAGE:
xConfiguration Tim e Z o ne: Zone
where
Zone
: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/
Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/
Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry,
Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/
Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/
Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville,
Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo,
Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/
Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo,
Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/
Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/
Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/
ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/
La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/
Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/
Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion,
America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/
Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista,
America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay,
America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca,
America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/
Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba,
America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek,
America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe,
America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne,
America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/
Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/
Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo,
America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/
Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/
Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit,
America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/
Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima,
America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio,
America/Managua, America/Manaus, America/Marigot, America/Martinique, America/
Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida,
America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/
Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau,
America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_
Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem,
America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/
Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/
Porto_Velho, America/Puerto_Rico, America/Rainy_River, America/Rankin_Inlet, America/
Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/
Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/
Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_
Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas,
America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule,
America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/
Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat,
America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville,
Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer,
Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/
Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau,
Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/
Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita,
Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/
Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Gaza, Asia/Harbin, Asia/
Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/
Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/
Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk,
Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan,
Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk,
Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/
Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/
Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent,
Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk,
Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/
Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores,
Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe,
Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/
St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/
Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/
Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne,
Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South,
Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/
Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 78
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Atlantic, Canada/Central, Canada/East-Saskatchewan, Canada/Eastern, Canada/Mountain,
Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/
Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0,
Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/
GM T+ 5 , E t c / G M T+6 , E t c / G MT+7, Et c /G MT+8, Etc/GM T+ 9, Etc /G M T- 0 , E t c / G MT-1, Et c /G M T-10,
Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/
GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/Greenwich, Etc/UCT,
Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan,
Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/
Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/
Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/
Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov,
Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid,
Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/
Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/
Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Simferopol, Europe/
Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol,
Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna,
Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye,
Europe/Zurich, GB, GB-Eire, GMT, GMT+0, GMT-0, GMT0, Greenwich, HST, Hongkong,
Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro,
Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/
Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/
BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/
Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter,
Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/
Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/
Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/
Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea,
Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/
Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/
Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland,
Portugal, ROC, ROK, Singapore, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/
Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/
Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, WET, Zulu
Select a time zone from the list.
UserInterface configuration
xConfiguration UserInterface ContactInfo Type
Choose which type of contact information to show on the Home screen, and when you tap the
Settings icon.
Requires user role: ADMIN
Default value: Auto
USAGE:
xConfiguration UserInterface ContactInfo T y pe: Type
where
Type
: Auto/None/IPv4/IPv6/SipUri/SystemName/DisplayName
Auto: Show the address which another system can dial to reach this system. The
address depends on the system registration.
None: Do not show any contact information.
IPv4: Show the system's IPv4 address.
IPv6: Show the system's IPv6 address.
SipUri: Show the system's SIP URI (refer to the SIP URI setting).
SystemName: Show the system's name (refer to the SystemUnit Name setting).
DisplayName: Show the system's display name (refer to the SIP DisplayName setting).
xConfiguration UserInterface CustomMessage
A custom message can be displayed, in the lower left side of the screen, in awake mode.
Requires user role: ADMIN, INTEGRATOR
Default value: ""
USAGE:
xConfiguration UserInterface Cust o m Mess age: "Custom Message"
where
CustomMessage
Add a custom message. Add an empty string to remove a custom message.
: String (0..128)
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 79
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration UserInterface KeyTones Mode
You can configure the system to make a keyboard click sound effect (key tone) when typing text
or numbers.
Requires user role: ADMIN, USER
Default value: Off
USAGE:
xConfiguration UserInterface KeyTones M od e: Mode
where
Mode
: Off/On
Off: There is no key tone sound effect.
On: The key tone sound effect is turned on.
xConfiguration UserInterface Language
Select the language to be used in menus and messages on the screen. If the language is not
supported, the default language (English) will be used.
Requires user role: ADMIN, USER
Default value: English
USAGE:
xConfiguration UserInterface Language: Language
where
Language
EnglishUK/Finnish/French/FrenchCanadian/German/Hebrew/Hungarian/Italian/Japanese/
Korean/Norwegian/Polish/Portuguese/PortugueseBrazilian/Russian/Spanish/SpanishLatin/
Swedish/Turkish
: Arabic/Catalan/ChineseSimplified/ChineseTraditional/Czech/Danish/Dutch/English/
Select a language from the list.
xConfiguration UserInterface OSD HalfwakeMessage
A custom message can be displayed in the middle of the main screen when the system is in
the half wake state. This will replace the default message "Tap the touch panel to get started"
together with an illustration of a Touch panel. You can also choose not to have a message.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration UserInterface OSD HalfwakeMessage: "Halfwake Message"
where
HalfwakeMessage
Add a custom message. If you add a space, there will be no visible message. Add an
empty string to remove a custom message.
: String (0..128)
xConfiguration UserInterface OSD Output
Define on which monitor the on-screen menus, information and indicators (OSD) should be
displayed. The system supports only one monitor, so this value is fixed and cannot be changed.
Requires user role: ADMIN, INTEGRATOR
Default value: Auto
USAGE:
xConfiguration UserInterface OSD Output: Output
where
Output
: Auto
Auto: The system sends the on-screen information and indicators to the system's
integrated display.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 80
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration UserInterface OSD SettingsMenu Mode
The Settings panel in the user interface (Touch 10 or on-screen) can be protected by the
video system’s admin password. If this password is blank, anyone can access the settings in
the Settings menu, and for example factory reset the system. If authentication is enabled, all
settings that require authentication have a padlock icon. You will be prompted to enter the
administrator’s user name and passphrase when you select the setting. Some settings do not
require authentication, they do not have a padlock icon.
Requires user role: ADMIN
Default value: Unlocked
USAGE:
xConfiguration UserInterface OSD SettingsMenu M o d e: Mode
where
Mode
: Locked/Unlocked
Locked: Authentication with administrator's username and passphrase is required.
Unlocked: No authentication is required.
UserManagement configuration
xConfiguration UserManagement LDAP Mode
The video system supports the use of an LDAP (Lightweight Directory Access Protocol) server
as a central place to store and validate user names and passwords. Use this setting to configure whether or not to use LDAP authentication. Our implementation is tested for the Microsoft
Active Directory (AD) service.
Requires user role: ADMIN
Default value: Off
USAGE:
xConfiguration UserManagem ent LDAP M o d e: Mode
where
Mode
: Off/On
Off: LDAP authentication is not allowed.
On: For client cer tificate verification to work when LDAP authentication is enabled, the
codec requires a CA (Certificate Authority) certificate, and the user must have a Client
Certificate that matches their user distinguishing name (DN) in the active directory (AD).
xConfiguration UserManagement LDAP Server Address
Set the IP address or hostname of the LDAP server.
Requires user role: ADMIN
Default value: ""
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
USAGE:
xConfiguration UserManagem ent LDAP Server Add r e s s: "Address"
where
Address
: String (0, 255)
A valid IPv4 address, IPv6 address or hostname.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 81
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration UserManagement LDAP Server Port
Set the port to connect to the LDAP server on. If set to 0, use the default for the selected
protocol (see the UserManagement LDAP Encryption setting).
Requires user role: ADMIN
Default value: 0
USAGE:
xConfiguration UserManagem ent LDAP Server Port: Port
where
Port
: Integer (0..65535)
The LDAP server por t number.
xConfiguration UserManagement LDAP Encryption
Define how to secure the communication between the video system and the LDAP server. You
can override the port number by using the UserManagement LDAP Server Port setting.
Requires user role: ADMIN
Default value: LDAPS
USAGE:
xConfiguration UserManagem ent LDAP E ncr y pt ion: Encr y ption
where
Enc ryption
: LDAPS/None/STARTTLS
LDAPS: Connect to the LDAP server on port 636 over TLS (Transport Layer Security).
None: Connect to LDAP server on port 389 with no encryption.
STARTTLS: Connect to LDAP ser ver on port 389, then send STARTTLS to enable TLS
encryption.
xConfiguration UserManagement LDAP MinimumTLSVersion
Set the lowest version of the TLS (Transport Layer Security) protocol that is allowed.
Requires user role: ADMIN
Default value: TLSv1.2
USAGE:
xConfiguration UserManagem ent LDAP M i ni m u m TLSVer sion: Mini mumTLSVersion
where
Mini mumTLSVersion
TLSv1.0: Support TLS version 1.0 or higher.
TLSv1.1: Support TLS version 1.1 or higher.
TLSv1.2: Support TLS version 1.2 or higher.
: T LSv1.0/ T LSv1.1/TL S v1. 2
xConfiguration UserManagement LDAP VerifyServerCertificate
When the video system connects to an LDAP server, the server will identify itself to the video
system by presenting its certificate. Use this setting to determine whether or not the video
system will verify the server certificate.
Requires user role: ADMIN
Default value: On
USAGE:
xConfiguration UserManagem ent LDAP VerifyServerCertificate:
VerifyServerCertificate
where
VerifyServerCertificate
Off: The video system will not verify the LDAP server’s certificate.
On: The video system must verify that the LDAP server’s certificate is signed by a
trusted Certificate Authority (CA). The CA must be on the list of trusted CAs that are
uploaded to the system in advance. Use the video system’s web interface to manage
the list of trusted CAs (see more details in the administrator guide).
: Off/On
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 82
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration UserManagement LDAP Admin Filter
The LDAP filter is used to determine which users should be granted administrator privileges. If
set, this setting takes precedence over the UserManagement LDAP Admin Group setting.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration UserManagem ent LDAP Admin Filter: "Fi lter "
where
Filte r
: String (0, 1024)
Refer to the LDAP specification for the syntax of this string. Example: "(CN=adminuser)"
xConfiguration UserManagement LDAP Admin Group
Members of this AD (Active Directory) group will be given administrator access. This
setting is a shorthand for saying (memberOf:1.2.840.113556.1.4.1941:=<group name>). If
UserManagement LDAP Admin Filter is set, this setting is ignored.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration UserManagem ent LDAP Admin Group: "Group"
where
Group
: String (0, 255)
The distinguishing name of the AD group. Example: "CN=admin_group, OU=company
groups, DC=company, DC=com"
xConfiguration UserManagement LDAP Attribute
The attribute used to map to the provided username. If not set, sAMAccountName is used.
Requires user role: ADMIN
Default value: ""
USAGE:
xConfiguration UserManagem ent LDAP Attribute: "Attribute"
where
Attribute
: String (0, 255)
The attribute name.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 83
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
Video configuration
xConfiguration Video DefaultMainSource
Define which video input source to be used as the default main video source when you start a
call.
Requires user role: ADMIN, USER
Default value: 1
USAGE:
xConfiguration Video DefaultMainSource: DefaultMainSource
where
DefaultMainSource
Set the source to be used as the default main video source.
xConfiguration Video Input Connector [1..2] CameraControl Mode
Define whether a camera can be controlled or not. This value is fixed for both Connector 1
(integrated camera) and Connector 2 (HDMI), and cannot be changed.
Requires user role: ADMIN, INTEGRATOR
Default value: Off
USAGE:
xConfiguration Video Input Connector n CameraControl Mo de: Mode
where
n
: Unique ID that identifies the video input connector. Range: 1..2
Mode
: Off
Off: Disable camera control.
: 1
xConfiguration Video Input Connector [1..2] CameraControl CameraId
The camera ID is a unique identifier of the cameras that are connected to the video input.
Requires user role: ADMIN, INTEGRATOR
Default value: 1
USAGE:
xConfiguration Video Input Connector n CameraControl Ca meraId: CameraId
where
n
: Unique ID that identifies the video input connector. Range: 1..2
Ca m e raId
: 1
The camera ID is fixed and cannot be changed.
xConfiguration Video Input Connector [1..2] InputSourceType
Select which type of input source is connected to the video input.
Note that Connector 1 is the system's integrated camera.
Requires user role: ADMIN, INTEGRATOR
Default value: Connector 1: camera Connector 2: PC
USAGE:
xConfiguration Video Input Connector n InputSourceType: InputSourceTy pe
where
n
: Unique ID that identifies the video input connector. Range: 1..2
InputSourceTyp e
mediaplayer/whiteboard/other
Camera: Use this when a camera is connected to the video input.
Document_camera: Use this when a document camera is connected to the video input.
Mediaplayer: Use this when a media player is connected to the video input.
PC: Use this when a computer is connected to the video input.
Whiteboard: Use this when a whiteboard camera is connected to the video input.
Other: Use this when the other options do not match.
: Connector 1: camera Connector 2: PC/camera/document_camera/
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 84
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Video Input Connector [1..2] Name
Define a name for the video input connector.
Requires user role: ADMIN, INTEGRATOR
Default value: ""
USAGE:
xConfiguration Video Input Connector n Na m e: "Nam e"
where
n
: Unique ID that identifies the video input connector. Range: 1..2
Name
: String (0, 50)
Name for the video input connector.
xConfiguration Video Input Connector [2] PresentationSelection
Define how the video system will behave when you connect a presentation source to the video
input.
If the video system is in standby mode, it will wake up when you connect a presentation source.
Sharing the presentation with the far end requires additional action (select Share on the user
interface) except when this setting is set to AutoShare.
Requires user role: ADMIN, INTEGRATOR
Default value: Desktop
USAGE:
xConfiguration Video Input Connector n PresentationSelection:
PresentationSelection
where
n
: Unique ID that identifies the video input connector. Range: 2..2
PresentationSelection
AutoShare: While in a call, the content on the video input will automatically be presented
to the far end as well as on the local screen when you connect the cable, or when the
source is activated otherwise (for example when a connected computer wakes up from
sleep mode). You do not have to select Share on the user interface. If a presentation
source is already connected when you make or answer a call, you have to manually
select Share on the user interface.
Desktop: The content on the video input will be presented on the screen when you
connect the cable, or when the source is activated otherwise (for example when a
connected computer wakes up from sleep mode). This applies both when idle and in a
call. Also, the content on the video input will stay on the screen when you leave the call,
provided that it was the active input at the time of leaving.
Manual: The content on the video input will not be presented on the screen until you
select Share from the user interface.
OnConnect: The content on the video input will be presented on screen when you
connect the cable, or when the source is activated otherwise (for example when a
connected computer wakes up from sleep mode). Otherwise, the behavior is the same
as in manual mode.
: AutoShare/Desktop/Manual/OnConnect
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 85
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Video Input Connector [2] Quality
When encoding and transmitting video there is a trade-off between high resolution and high
frame rate. For some video sources it is more important to transmit high frame rate than high
resolution and vice versa. This setting specifies whether to give priority to high frame rate or to
high resolution.
Requires user role: ADMIN, INTEGRATOR
Default value: Sharpness
USAGE:
xConfiguration Video Input Connector n Quality: Qu a lity
where
n
: Unique ID that identifies the video input connector. Range: 2..2
Qu a lity
: Motion/Sharpness
Motion: Gives the highest possible frame rate. Used when there is a need for higher
frame rates, typically when a large number of participants are present or when there is
a lot of motion in the picture.
Sharpness: Gives the highest possible resolution. Used when you want the highest
quality of detailed images and graphics.
xConfiguration Video Input Connector [1..2] Visibility
Define the visibility of the video input connector in the menus on the user interface.
Note that Connector 1 is the system's integrated camera, which is not available as a presenta-
tion source.
Requires user role: ADMIN, INTEGRATOR
Default value: Connector 1: Never Connector 2: Always Connector 3: OnConnect
USAGE:
xConfiguration Video Input Connector n Visibility: Visibility
where
n
: Unique ID that identifies the video input connector. Range: 1..2
Visibility
: Connector 1: Never Connector 2, 3: Always/IfSignal/Never
Always: The menu selection for the video input connector will always be visible on the
user interface.
IfSignal: Yhe menu selection for the video input connector will only be visible when
something is connected to the video input.
Never: The input source is not expected to be used as a presentation source, and will
not show up on the user interface.
xConfiguration Video Monitors
Define the monitor layout mode. Note that this video system supports only one monitor, so this
value is fixed and cannot be changed.
Requires user role: ADMIN, INTEGRATOR
Default value: Single
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
USAGE:
xConfiguration Video M o n ito r s: M onitors
where
Mon itors
: Single
Single: The layout is shown on the video system's monitor.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 86
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Video Output Connector [2] CEC Mode
The HDMI output (Output Connector 2) is for future use.
USAGE:
xConfiguration Video Output Connector n CEC Mode: Mode
where
n
: Unique ID that identifies the video output connector. Range: 2..2
xConfiguration Video Output Connector [2] OverscanLevel
The HDMI output (Output Connector 2) is for future use.
USAGE:
xConfiguration Video Output Connector n OverscanLevel: OverscanLevel
where
n
: Unique ID that identifies the video output connector. Range: 2..2
xConfiguration Video Output Connector [1..2] Resolution
Connector 1: The resolution and refresh rate for the integrated display. This value is fixed and
cannot be changed.
Connector 2: The HDMI output (Output Connector 2) is for future use.
Default value: Connector 1: 1920_1080_60
USAGE:
xConfiguration Video Output Connector n Resolution: Resolut ion
where
n
: Unique ID that identifies the video output connector. Range: 1..2
Resolution
: Connector 1: 1920_1080_60
1920_1080_60: The resolution is 1920 x 1080, and the refresh rate is 60 Hz.
xConfiguration Video Presentation DefaultSource
Define which video input source to use as a default presentation source. This setting may be
used by the API and 3rd par ty user interfaces. It is not relevant when using the user interfaces
provided by Cisco.
Requires user role: ADMIN, USER
Default value: 2
USAGE:
xConfiguration Video Presentation Defau lt Source: De fa ultS ou r c e
where
Defau ltS ourc e
The video input source to use as default presentation source.
: 2
xConfiguration Video Selfview Default Mode
Define if the main video source (self-view) shall be displayed on screen after a call. The position
and size of the self-view window is determined by the Video Selfview Default PIPPosition and
the Video Selfview Default FullscreenMode settings respectively.
Requires user role: ADMIN, INTEGRATOR
Default value: Current
USAGE:
xConfiguration Video Selfview Default Mode: Mode
where
Mode
: Off/Current/On
Off: self-view is switched off when leaving a call.
Current: self-view is left as is, i.e. if it was on during the call, it remains on after the call;
if it was off during the call, it remains off after the call.
On: self-view is switched on when leaving a call.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 87
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
API Reference Guide
xConfiguration Video Selfview Default FullscreenMode
Define if the main video source (self-view) shall be shown in full screen or as a small picturein-picture (PiP) after a call. The setting only takes effect when self-view is switched on (see the
Video Selfview Default Mode setting).
Requires user role: ADMIN, INTEGRATOR
Default value: Current
USAGE:
xConfiguration Video Selfview Default Full s creen M o d e: FullscreenMode
where
Fullscreen Mode
Off: self-view will be shown as a PiP.
Current: The size of the self-view picture will be kept unchanged when leaving a call, i.e.
if it was a PiP during the call, it remains a PiP after the call; if it was fullscreen during the
call, it remains fullscreen after the call.
On: The self-view picture will be shown in fullscreen.
: Off/Current/On
xConfiguration Video Selfview Default OnMonitorRole
Define which monitor to display the main video source (self-view) on after a call. Note that this
video system has only one monitor, so this value is fixed and cannot be changed.
Requires user role: ADMIN, INTEGRATOR
Default value: First
xConfiguration Video Selfview Default PIPPosition
Define the position on screen of the small self-view picture-in-picture (PiP) after a call. The
setting only takes effect when self-view is switched on (see the Video Selfview Default Mode
setting) and fullscreen view is switched off (see the Video Selfview Default FullscreenMode
setting).
Requires user role: ADMIN, INTEGRATOR
Default value: Current
USAGE:
xConfiguration Video Selfview Default PIPP osit ion: PIPP ositio n
where
PIPPosition
LowerLeft/LowerRight
: Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/
Current: The position of the self-view PiP will be kept unchanged when leaving a call.
UpperLeft: The self-view PiP will appear in the upper left corner of the screen.
UpperCenter: The self-view PiP will appear in the upper center position.
UpperRight: The self-view PiP will appear in the upper right corner of the screen.
CenterLeft: The self-view PiP will appear in the center left position.
CentreRight: The self-view PiP will appear in the center right position.
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.
USAGE:
xConfiguration Video Selfview Default OnMonitorRole: OnMonitorRole
where
OnMonitorRole
First: The self-view picture will be shown on the integrated screen.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
: First
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 88
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
xConfiguration Video Selfview OnCall Mode
This setting is used to switch on self-view for a short while when setting up a call. The Video
Selfview OnCall Duration setting determines for how long it remains on. This applies when selfview in general is switched off.
Requires user role: ADMIN, INTEGRATOR
Default value: On
USAGE:
xConfiguration Video Selfview OnCall Mode: Mode
where
Mode
: Off/On
Off: Self-view is not shown automatically during call setup.
On: Self-view is shown automatically during call setup.
xConfiguration Video Selfview OnCall Duration
This setting only has an effect when the Video Self view OnCall Mode setting is switched On. In
this case, the number of seconds set here determines for how long self-view is shown before it
is automatically switched off.
API Reference Guide
Requires user role: ADMIN, INTEGRATOR
Default value: 10
USAGE:
xConfiguration Video Selfview OnCall Duration: D uratio n
where
Durat ion
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
: Integer (1..60)
Range: Choose for how long self-view remains on. The valid range is between 1 and 60
seconds.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 89
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand commands
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Chapter 4
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 90
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
Description of the xCommand commands
In this chapter, you can find a complete list of all xCommand type commands with parameters.
We recommend you visit our web site regularly for updated versions of the manual.
Go to: http://www.cisco.com/go/dx-docs
API Reference Guide
xCommand Audio Diagnostics MeasureDelay ...........................................................................................95
xCommand Audio Microphones Mute
xCommand Audio Microphones ToggleMute
xCommand Audio Microphones Unmute
xCommand Audio Select
xCommand Audio Sound Play
xCommand Audio Sound Stop
xCommand Audio SoundsAndAlerts Ringtone List
xCommand Audio SoundsAndAlerts Ringtone Play
xCommand Audio Volume Decrease
xCommand Audio Volume Increase
xCommand Audio Volume Mute
xCommand Audio Volume Set
xCommand Audio Volume SetToDefault
xCommand Audio Volume ToggleMute
xCommand Audio Volume Unmute
xCommand Audio VuMeter Start
xCommand Audio VuMeter Stop
xCommand Audio VuMeter StopAll
Bookings commands
xCommand Bookings Clear
xCommand Bookings Get
xCommand Bookings List
Call commands
................................................................................................................................... 10 0
...........................................................................................................................95
............................................................................................................................ 99
....................................................................................................................... 99
......................................................................................................................... 99
......................................................................................................................... 99
........................................................................................................95
.............................................................................................95
...................................................................................................95
................................................................................................................... 96
.................................................................................................................. 96
.................................................................................. 96
................................................................................. 96
........................................................................................................ 96
...........................................................................................................97
.................................................................................................................97
...................................................................................................................97
....................................................................................................97
..................................................................................................... 98
........................................................................................................... 98
.............................................................................................................. 98
............................................................................................................... 98
........................................................................................................... 98
xCommand Call Accept........................................................................................................................... 100
xCommand Call Disconnect
xCommand Call DTMFSend
xCommand Call FarEndControl Camera Move
xCommand Call FarEndControl Camera Stop
xCommand Call FarEndControl RoomPreset Activate
xCommand Call FarEndControl Source Select
xCommand Call Forward
xCommand Call Hold
xCommand Call Ignore
xCommand Call Join
xCommand Call Reject
xCommand Call Resume
xCommand Call UnattendedTransfer
CallHistory commands
xCommand CallHistory AcknowledgeAllMissedCalls
xCommand CallHistory AcknowledgeMissedCall
xCommand CallHistory DeleteAll
xCommand CallHistory DeleteEntry
xCommand CallHistory Get
xCommand CallHistory Recents
Conference commands
xCommand Conference DoNotDisturb Activate
xCommand Conference DoNotDisturb Deactivate
.................................................................................................................... 100
.................................................................................................................... 100
....................................................................................... 100
.......................................................................................... 101
............................................................................. 101
........................................................................................ 101
.......................................................................................................................... 101
................................................................................................................................102
.............................................................................................................................102
................................................................................................................................102
.............................................................................................................................102
..........................................................................................................................102
.......................................................................................................102
........................................................................................................................ 103
..............................................................................103
....................................................................................103
.............................................................................................................103
.........................................................................................................103
......................................................................................................................104
..............................................................................................................104
...................................................................................................................... 105
......................................................................................105
..................................................................................105
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 91
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand Conference SpeakerLock Release .......................................................................................105
xCommand Conference SpeakerLock Set
Diagnostics commands
xCommand Diagnostics Run
Dial commands
xCommand Dial
HttpFeedback commands
xCommand HttpFeedback Deregister
xCommand HttpFeedback Register
Macros commands
xCommand Macros Log Clear
xCommand Macros Log Get
xCommand Macros Macro Activate
xCommand Macros Macro Deactivate
xCommand Macros Macro Get
xCommand Macros Macro Remove
xCommand Macros Macro Rename
xCommand Macros Macro Roles Set
xCommand Macros Macro Save
xCommand Macros Runtime Restart
xCommand Macros Runtime Start
xCommand Macros Runtime Status
xCommand Macros Runtime Stop
...................................................................................................................... 106
....................................................................................................................106
................................................................................................................................... 106
........................................................................................................................................106
...................................................................................................................107
............................................................................................................................. 108
................................................................................................................ 108
................................................................................................................... 10 8
............................................................................................................... 108
..............................................................................................................109
..............................................................................................105
.....................................................................................................107
......................................................................................................... 107
........................................................................................................ 108
.................................................................................................... 108
........................................................................................................ 108
.........................................................................................................109
......................................................................................................109
.......................................................................................................109
...........................................................................................................109
.........................................................................................................109
...........................................................................................................110
xCommand Peripherals Pairing DeviceDiscovery Start
xCommand Peripherals Pairing Pair
xCommand Peripherals Pairing Unpair
xCommand Peripherals Purge
Phonebook commands
xCommand Phonebook Contact Add
xCommand Phonebook Contact Delete................................................................................................... 113
xCommand Phonebook Contact Modify
xCommand Phonebook ContactMethod Add
xCommand Phonebook ContactMethod Delete
xCommand Phonebook ContactMethod Modify
xCommand Phonebook Folder Add
xCommand Phonebook Folder Delete
xCommand Phonebook Folder Modify.....................................................................................................11 6
xCommand Phonebook Search
Presentation commands
xCommand Presentation Start
xCommand Presentation Stop
Provisioning commands
xCommand Provisioning CompleteUpgrade
xCommand Provisioning PostponeUpgrade
xCommand Provisioning StartUpgrade
xCommand Provisioning ExtensionMobility Login
xCommand Provisioning ExtensionMobility Logout
........................................................................................................................113
......................................................................................................................118
......................................................................................................................118
......................................................................................................... 112
.................................................................................................... 112
................................................................................................................. 112
...................................................................................................... 113
.................................................................................................. 114
.......................................................................................... 114
......................................................................................................... 116
..................................................................................................... 116
............................................................................................................... 117
................................................................................................................. 118
................................................................................................................. 118
............................................................................................ 118
............................................................................................ 118
....................................................................................................118
........................................................................... 112
...................................................................................... 115
...................................................................................... 115
...................................................................................119
................................................................................. 119
Message commands
xCommand Message Send
Peripherals commands
xCommand Peripherals Connect
xCommand Peripherals HeartBeat
xCommand Peripherals List
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
...........................................................................................................................110
...................................................................................................................... 110
........................................................................................................................ 111
............................................................................................................. 111
........................................................................................................... 111
..................................................................................................................... 111
Proximity commands
xCommand Proximity Services Activate
xCommand Proximity Services Deactivate
Security commands
xCommand Security Certificates CA Add
xCommand Security Certificates CA Delete
...........................................................................................................................119
............................................................................................................................ 120
.................................................................................................. 119
.............................................................................................. 119
................................................................................................120
............................................................................................120
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 92
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand Security Certificates CA Show .............................................................................................120
xCommand Security Certificates Services Activate
xCommand Security Certificates Services Add
xCommand Security Certificates Services Deactivate
xCommand Security Certificates Services Delete
xCommand Security Certificates Services Show
xCommand Security Persistency
xCommand Security Session List
xCommand Security Session Terminate
Standby commands
xCommand Standby Activate
xCommand Standby Deactivate
xCommand Standby Halfwake
xCommand Standby ResetTimer..............................................................................................................123
SystemUnit commands
xCommand SystemUnit Boot
xCommand SystemUnit FactoryReset
xCommand SystemUnit FirstTimeWizard Stop
xCommand SystemUnit Notifications RemoveAll
xCommand SystemUnit OptionKey Add
xCommand SystemUnit OptionKey List
xCommand SystemUnit OptionKey Remove
xCommand SystemUnit OptionKey RemoveAll
xCommand SystemUnit SignInBanner Clear
xCommand SystemUnit SignInBanner Get
xCommand SystemUnit SignInBanner Set
xCommand SystemUnit SoftReset
xCommand SystemUnit SoftwareUpgrade
Time commands
xCommand Time DateTime Get
xCommand Time DateTime Set
............................................................................................................................ 123
....................................................................................................................... 124
..................................................................................................................................127
.............................................................................................................12 2
............................................................................................................12 2
..................................................................................................12 2
...................................................................................................................123
...............................................................................................................123
.................................................................................................................123
...................................................................................................................124
.....................................................................................................124
..................................................................................................125
...................................................................................................125
...........................................................................................................126
............................................................................................................... 127
...............................................................................................................127
................................................................................120
......................................................................................120
............................................................................ 121
.................................................................................. 121
.................................................................................... 121
........................................................................................125
....................................................................................125
............................................................................................125
........................................................................................126
...........................................................................................126
..............................................................................................126
...............................................................................................126
..............................................................................................126
UserInterface commands
xCommand UserInterface Branding Delete
xCommand UserInterface Branding Get
xCommand UserInterface Branding Updated
xCommand UserInterface Branding Upload
xCommand UserInterface Extensions Clear
xCommand UserInterface Extensions List
xCommand UserInterface Extensions Set
xCommand UserInterface Extensions Widget Action
xCommand UserInterface Extensions Widget SetValue
xCommand UserInterface Extensions Widget UnsetValue
xCommand UserInterface Message Alert Clear
xCommand UserInterface Message Alert Display
xCommand UserInterface Message Prompt Clear
xCommand UserInterface Message Prompt Display
xCommand UserInterface Message Prompt Response
xCommand UserInterface Message TextInput Clear
xCommand UserInterface Message TextInput Display
xCommand UserInterface Message TextLine Clear
xCommand UserInterface Message TextLine Display
xCommand UserInterface OSD Key Click
xCommand UserInterface OSD Key Press
xCommand UserInterface OSD Key Release
xCommand UserInterface Presentation ExternalSource Add
xCommand UserInterface Presentation ExternalSource List...................................................................133
xCommand UserInterface Presentation ExternalSource Remove
xCommand UserInterface Presentation ExternalSource RemoveAll
xCommand UserInterface Presentation ExternalSource Select
xCommand UserInterface Presentation ExternalSource State Set
UserManagement commands
xCommand UserManagement RemoteSupportUser Create
xCommand UserManagement RemoteSupportUser Delete
xCommand UserManagement RemoteSupportUser DisablePermanently
xCommand UserManagement RemoteSupportUser GetState
....................................................................................................................127
.............................................................................................127
.................................................................................................. 127
.......................................................................................... 127
............................................................................................128
............................................................................................128
...............................................................................................128
...............................................................................................128
..............................................................................128
..........................................................................129
......................................................................129
......................................................................................129
...................................................................................129
..................................................................................129
...............................................................................130
..........................................................................130
...............................................................................130
............................................................................ 131
................................................................................ 131
............................................................................. 131
................................................................................................132
...............................................................................................132
...........................................................................................132
..................................................................132
...........................................................133
.......................................................133
..............................................................133
.........................................................134
............................................................................................................. 134
...................................................................134
....................................................................134
..............................................134
................................................................135
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 93
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand UserManagement User Add .................................................................................................135
xCommand UserManagement User Delete
xCommand UserManagement User Get
xCommand UserManagement User List
xCommand UserManagement User Modify
xCommand UserManagement User Passphrase Change
xCommand UserManagement User Passphrase Set
.............................................................................................136
..................................................................................................136
..................................................................................................136
............................................................................................. 137
....................................................................... 137
..............................................................................137
Video commands
xCommand Video ActiveSpeakerPIP Set.................................................................................................138
xCommand Video Input SetMainVideoSource
xCommand Video Layout LayoutFamily Set
xCommand Video PresentationPIP Set
xCommand Video PresentationView Set
xCommand Video Selfview Set
................................................................................................................................ 138
.........................................................................................138
............................................................................................138
....................................................................................................138
.................................................................................................139
................................................................................................................139
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 94
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
Audio commands
xCommand Audio Diagnostics MeasureDelay
This command will measure the audio delay/latency in a device connected to the video system.
A typical use case it to measure the delay in a TV connected to the video system via the HDMI
connector. If the delay in a TV is too high, the real-time experience of a video call will be
substantially degraded. If the delay is more than 50 ms we recommend the user to find a TV
setting that has shorter delay. Typical T V settings that can reduce the delay are: Gaming Mode
and PC Mode.
This command will measure the delay between output and input (microphone). This means
that if you are using an external acoustic echo canceller or audio mixer, this command will also
measure the delay of these devices.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Diagnostics MeasureDelay [MeasurementLength: MeasurementLength]
[Output: Output] [Volu m e: Volu m e]
where
MeasurementLength
The length of the measurement in number of seconds. In a noisy environment a longer
measurement time will give a more reliable and robust result. The default is set to 6.
Output
: HDMI/Line/Internal/All
HDMI: Measure the delay of the device connected to the HDMI output.
Line: Measure the delay of the device connected to the Line output (only available on
video systems that have a Line output).
Internal: Measure the delay of the internal loudspeaker (only available on video systems
that have an internal loudspeaker).
All: Will measure the maximum delay of all outputs.
The default is set to HDMI.
Volume
: Integer (1..50)
The volume for the test signal. In a noisy environment a higher volume gives more
reliable and robust results. The default is set to 20.
: Integer (1..100)
xCommand Audio Microphones Mute
Mute all microphones.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio Microphones Mute
xCommand Audio Microphones ToggleMute
Toggle the microphone between muted and unmuted.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio Microphones ToggleMute
xCommand Audio Microphones Unmute
Unmute all microphones.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio Microphones Unmute
xCommand Audio Select
Select which type of audio device to use (built-in loudspeakers and microphone, headsets, or
handset).
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Select Devic e: Devic e
where
Device
: Internal/HeadsetBluetooth/HeadsetAnalog/HeadsetUSB/HandsetUSB
Choose whether to use the built-in loudspeakers and microphone (internal), a Bluetooth
headset, an analog headset (DX70 only), a USB headset, or a USB handset.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 95
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand Audio Sound Play
Play a specified audio sound.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio Sound Pl ay [Loop: Loop] Sound: Sound
where
Loop
: Off/On
Determines whether or not to loop the playout of the audio sound. The sound is
looped by default. Irrespective of how this parameter is set, some of the sounds
(Busy, CallWaiting, Dial, Ringing, and SpecialInfo) will play until the Audio Sound Stop
command is issued. The default is set to Off.
Sound
: Alert/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/
KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/Ringing/
SignIn/SpecialInfo/TelephoneCall/VideoCall/VolumeAdjust/WakeUp
Choose which ringtone to play.
xCommand Audio Sound Stop
Stop playing audio sound.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio Sound Stop
xCommand Audio SoundsAndAlerts Ringtone List
List all available ringtones. Use the xConfiguration Audio SoundsAndAlerts RingTone setting to
choose a ringtone.
Requires user role: ADMIN, INTEGRATOR, USER
xCommand Audio SoundsAndAlerts Ringtone Play
Play one of the available ringtones. Use the xCommand Audio SoundsAndAlerts Ringtone List
command to get a list of the available ringtones.
Requires user role: ADMIN, INTEGRATOR, USER
USAGE:
xCommand Audio SoundsAndAlerts Ringtone Pl ay R i n g T one: "RingTone"
where
RingTone
: String (1, 100)
The name of the ringtone.
xCommand Audio Volume Decrease
Decrease the volume on one of the endpoint's audio devices (built-in loudspeakers, headsets,
or handset). By default, the volume is decreased by 5 steps (each step is 0.5 dB). Use the
Steps parameter if you want to override the default behavior.
You can use the optional Device parameter to specify which device to address. The
most recently selected device is chosen if you don't specify a device (see xStatus Audio
SelectedDevice). Also refer to xCommand Audio Select.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me Decrease [Devic e: Devic e] [Ste p s: Steps]
where
Device
: Internal/HeadsetBluetooth/HeadsetAnalog/HeadsetUSB/HandsetUSB
Choose whether to decrease the volume on the built-in loudspeakers (internal), a
Bluetooth headset, an analog headset (DX70 only), a USB headset, or a USB handset.
Steps
: Integer (1..10)
Choose the number of steps to decrease the volume with. One step is 0.5 dB. The
default is set to 5.
USAGE:
xCommand Audio SoundsAndAlerts Ringtone List
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 96
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand Audio Volume Increase
Increase the volume on one of the endpoint's audio devices (built-in loudspeakers, headsets,
or handset). By default, the volume is increased by 5 steps (each step is 0.5 dB). Use the Steps
parameter if you want to override the default behavior.
You can use the optional Device parameter to specify which device to address. The
most recently selected device is chosen if you don't specify a device (see xStatus Audio
SelectedDevice). Also refer to xCommand Audio Select.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me Increase [D ev ice: D evice] [St e ps: Steps]
where
Device
: Internal/HeadsetBluetooth/HeadsetAnalog/HeadsetUSB/HandsetUSB
Choose whether to increase the volume on the built-in loudspeakers (internal), a
Bluetooth headset, an analog headset (DX70 only), a USB headset, or a USB handset.
Steps
: Integer (1..10)
Choose the number of steps to increase the volume with. One step is 0.5 dB. The
default is set to 5.
xCommand Audio Volume Mute
Mute the volume on the selected audio device (built-in loudspeakers, headsets, or handset).
Refer to the xStatus Audio SelectedDevice and xCommand Audio Select commands for more
information about the selected device.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me Mute
xCommand Audio Volume Set
Set the volume on one of the endpoint's audio devices (built-in loudspeakers, headsets, or
handset) to a specified level. You can use the optional Device parameter to specify which
device to address. The most recently selected device is chosen if you don't specify a device
(see xStatus Audio SelectedDevice). Also refer to xCommand Audio Select.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me Set [D e vic e: D evice] L e v e l: Level
where
Device
: Internal/HeadsetBluetooth/HeadsetAnalog/HeadsetUSB/HandsetUSB
Choose whether to set the volume on the built-in loudspeakers (internal), a Bluetooth
headset, an analog headset (DX70 only), a USB headset, or a USB handset.
Level
: Integer (0..100)
Select the gain level. 70 equals 0 dB gain, and 100 equals 15 dB gain.
xCommand Audio Volume SetToDefault
Set the volume on one of the endpoint's audio devices (built-in loudspeakers, headsets, or
handset) to the default level as defined in the xConfiguration Audio DefaultVolume setting. You
can use the optional Device parameter to specify which device to address. The most recently
selected device is chosen if you don't specify a device (see xStatus Audio SelectedDevice).
Also refer to xCommand Audio Select.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me SetToDefault [Devic e: Device]
where
Device
: Internal/HeadsetBluetooth/HeadsetAnalog/HeadsetUSB/HandsetUSB
Choose whether to set the volume on the built-in loudspeakers (intern), a Bluetooth
headset, an analog headset (DX70 only), a USB headset, or a USB handset.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 97
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
xCommand Audio Volume ToggleMute
Toggle the loudspeaker between muted and unmuted.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me ToggleMute
xCommand Audio Volume Unmute
Set the volume on the endpoint back on after muting.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio Volu me Un mute
xCommand Audio VuMeter Start
Start a VU meter to show the audio signal level on the specified connector. You have to specify
both the connector's type and number (ConnectorType, ConnectorId) to uniquely identify the
connector. The VU meter measures the input level for frequencies below 20 kHz.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio VuMeter Start ConnectorID: ConnectorID ConnectorType:
ConnectorType [IncludePairingQuality: IncludePairingQuality]
where
ConnectorID
ConnectorType
IncludePairingQuality
: Integer(1..1)
Select a connector number. Together with the ConnectorType it uniquely identifies
the connector. Microphone [1] refers to the selected audio device (built-in loudspeakers, headsets, or handset). Refer to the xStatus Audio SelectedDevice and xCommand
Audio Select commends for more information about the selected device.
: HDMI/Microphone
Select the connector type.
: Literal (Off / On )
The default is set to Off
xCommand Audio VuMeter Stop
Stop the VU meter on the specified connector. You have to specify both the connector's type
and number (ConnectorType, ConnectorId) to uniquely identify the connector.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio VuMeter Stop ConnectorID: ConnectorID ConnectorType:
ConnectorType
where
ConnectorID
Select a connector number. Together with the ConnectorType it uniquely identifies
the connector. Microphone [1] refers to the selected audio device (built-in loudspeakers, headsets, or handset). Refer to the xStatus Audio SelectedDevice and xCommand
Audio Select commends for more information about the selected device.
ConnectorType
Select the connector type.
: Integer(1..1)
: HDMI/Microphone
xCommand Audio VuMeter StopAll
Stop all VU meters.
Requires user role: ADMIN, USER
USAGE:
xCommand Audio VuMeter StopAll
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 98
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
Bookings commands
xCommand Bookings Clear
Clear the current stored list of bookings.
Requires user role: ADMIN, USER
USAGE:
xCommand Bookings Clear
xCommand Bookings Get
Get the booking information for a specific ID.
Requires user role: ADMIN, USER
USAGE:
xCommand Bookings Get Id: "Id"
where
Id
: String (0, 128)
The booking ID of a call or conference.
xCommand Bookings List
List the stored bookings for the system. The list of booking details is received from the
management system. All parameters are optional, and can be used to limit the search result.
If no parameters are set, past, present and future bookings are all listed. To avoid listing
bookings from yesterday and before, use DayOffset = 0.
Requires user role: ADMIN, USER
USAGE:
xCommand Bookings List [D ays: Days] [D ay Offs et: D ayOffset] [Limit: Li m it]
[Of fset: Offset]
where
Days
: Integer (1..365)
Number of days to retrieve bookings from.
DayOffset
Li m it
Offset
: Integer (0..365)
Which day to start the search from (today: 0, tomorrow: 1…). The default is set to 0.
: Integer (1..65534)
Max number of bookings to list.
: Integer (0..65534)
Offset number of bookings for this search. The default is set to 0.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 99
Cisco TelePresence DX70 and DX80
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
API Reference Guide
Call commands
xCommand Call Accept
Accept an incoming call. If no CallId is specified, all incoming calls are accepted.
Requires user role: ADMIN, USER
USAGE:
xCommand Call Accept [C a l l Id: Ca l lId ]
where
Ca llId
: Integer (0..65534)
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. The default is set to 0.
xCommand Call Disconnect
Disconnect a call.
Requires user role: ADMIN,INTEGRATOR, USER
USAGE:
xCommand Call Disconnect [Ca l l Id: Cal lId ]
where
Ca llId
: Integer (0..65534)
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. The default is set to 0.
xCommand Call DTMFSend
Send DTMF tones to the far end.
Requires user role: ADMIN, USER
USAGE:
xCommand Call DTMFSend [C a l l Id: Cal lId ] DTMFString: "DTMFString"
where
Ca llId
: Integer (0..65534)
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. The default is set to -1.
DTMFString
: String (0, 32)
Enter the DTMF string.
xCommand Call FarEndControl Camera Move
Move the far end camera (the remote camera).
NOTE: The far end camera moves in the specified direction until the stop command (ref:
xCommand FarEndControl Camera Stop) is issued.
Requires user role: ADMIN, USER
USAGE:
xCommand Call FarEndControl Camera Move [CallId: C allId ] Value: Value
where
Ca llId
: Integer (0..65534)
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. The default is set to -1.
Valu e
: Left/Right/Up/Down/ZoomIn/ZoomOut
Select the action for how to move the camera.
D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved. 100
Loading...