Cisco MX700, MX800 Reference Manual

Download

Cisco TelePresence MX700 and MX800

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 MX700 and MX800

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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/mx-docs

Table of ContentsWhat’s in this guide?

Introduction ........................................................................... 3

About this guide

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

RS-232 / serial connection ................................................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

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

.......................................................................235

........................................................... 31

.........................................35

...................................................................... 37

.................................................. 38

......................39

..................................................... 108

......................... 109

........................................................... 172

................................ 173

..........................................................236

..............................................237

...........................................239

........................240

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Chapter 1

Introduction

Cisco TelePresence MX700 and MX800

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 MX700 and MX800

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.

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/mx-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 theUser documentation on the

Cisco web site appendix.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 and user interface in both the halfwake state and the awake state.

In the Halfwake state you can:

• Add a background brand image to the screen and user interface.

• Add a small logo in the bottom right corner of the screen and user interface.

In the Awake state you can:

• Add a small logo in the bottom right corner of the screen and user interface.

• Add a label or message in the bottom left corner of the screen (not the user interface).

Source composition

You can compose up to four input sources (depending on how many input sources are available on the codec) into one image. This is the image that will be sent in the main video stream to the far end in a call. Source composition can only be enabled via the API, so we recommend creating a user interface extension combined with a macro to control the compositions on demand.

This feature replaces some of the functionality that was provided by the TC Console application for TC software.

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 (To u ch 10) 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.

Support for the Snap to Whiteboard feature

The Snap to Whiteboard feature is now available for all products that have a camera with speaker track functionality: SX80 with Cisco TelePresence Speaker Track 60 camera or Cisco Spark Quad camera, MX700/MX800 with dual camera, RoomKit, RoomKit Plus, Room 55 and Room70.

When the video system detects a person that is speaking close to the whiteboard, the camera view will switch to the whiteboard area. The wizard in the Settings panel on the Touch 10 user interface helps you to set up the feature and define where the whiteboard area is.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

Briefing Room mode

The Briefing Room feature, which was introduced already in TC software, has been reworked. The in-room control framework is used for creating the associated user interface elements.

As before, Briefing Room is suppor ted only for dual camera systems. Also, you need a Precision 60 camera, and a total of three screens.

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.

Certificate upload via API

ASCII PEM formatted certificates can be installed directly using multiline API commands (

. When issuing the display command a prompt

Ceritifcates CA Add Services Add

system from its web interface, as before.

xCommand UserInterface Message

xCommand Security

, or

xCommand Security Ceritifcates

). You can also upload certificates to a video

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 10 user 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.

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.

xCommand UserManagement User *

). As before,

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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

Configuration changes in CE9.2

New configurations

Audio Ultrasound MaxVolume

Cameras Camera[1..2] Focus Mode

Added for the integrated cameras

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

Configurations that are removed

None

Cameras SpeakerTrack Whiteboard Mode

OLD: User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, INTEGRATOR, USER

UserInterface Language

NEW: Arabic and Hebrew added to valuespace

Configurations that are modified

Cameras Camera[n] Focus Mode

OLD: Value space: Auto/Manual NEW: Value space: Auto/AutoLimited/Manual

Cameras SpeakerTrack Closeup

OLD: User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, INTEGRATOR, USER

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

SystemUnit ProductPlatform Set

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

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

Audio SpeakerCheck

OLD: Volume: Integer(1..10) NEW: Volume: Integer(1..30)

Call Disconnect

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER

Camera PositionReset

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER

Camera PositionSet

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER Added: Lens: Wide / Center / Left / Right

Camera Ramp

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras PresenterTrack ClearPosition

OLD: User role: INTEGRATOR, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras PresenterTrack Set

OLD: User role: INTEGRATOR, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras PresenterTrack StorePosition

OLD: User role: INTEGRATOR, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras SpeakerTrack Diagnostics Start

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras SpeakerTrack Diagnostics Stop

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER

Cameras SpeakerTrack Whiteboard ActivatePosition

Removed: Camera Added: CameraId: Integer (1..7)

Cameras SpeakerTrack Whiteboard AlignPosition

Removed: Camera Added: CameraId: Integer (1..7)

Cameras SpeakerTrack Whiteboard StorePosition

Removed: Camera Added: CameraId: Integer (1..7)

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

Status changes in CE9.2

New statuses

Cameras Camera[n] DetectedConnector

Cameras Camera[n] Position Lens

Cameras SpeakerTrack ActiveConnector

Video Output Connector[n] ConnectedDevice CEC[n] LogicalAddress

Video Output Connector[n] ConnectedDevice ScreenSize

Statuses that are removed

Cameras SpeakerTrack LeftCamera VideoInputConnector

Cameras SpeakerTrack RightCamera VideoInputConnector

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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/ collaboration-endpoints/telepresence-mx-series/ products-release-notes-list.html

New features and improvements

Dual Screen experience and Active Control for CMS based meetings

Dual screen video systems can utilize both screens for video in a CMS based meeting. The video system receives two transcoded video streams and one content stream from the CMS, and utilizes both screens to render the streams.

With Active Control enabled, you get a participant list that shows all meeting participants and their current activity status, such as mute, sharing and active speaker indication. You can change the layout seamlessly from the touch interface by using the layout selection panels.

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. It will also wake to this state when a user pairs a Cisco Proximity client to the system.

Additions for Room Analytics

Detect people presence in the room: The video system has

the capability to find whether there are people present in the room. The feature is based on ultrasound, and it does not keep record of who was in the room, only whether or not the room is in use.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

System configuration changes in CE9.1

New configurations

RoomAnalytics PeoplePresenceDetector

Configurations that are removed

None.

Configurations that are modified

Conference DefaultCal Rate

OLD: Default value: 3072 NEW: Default value: 6000

Conference MultiStream Mode

OLD: Valuespace: Off; Default value: Off NEW: Valuespace: Auto/Off; Default value: Auto

Network[ 1] IEEE8021X Password

OLD: Valuespace: String(0, 32) NEW: Valuespace: String(0, 50)

Video Input Connector [n] PresentationSelection

OLD: Valuespace: AutoShare/Manual/OnConnect NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect

API Reference Guide

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

Cameras SpeakerTrack Diagnostics Start

OLD: User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, USER

Cameras SpeakerTrack Diagnostics Stop

OLD: User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, USER

SystemUnit FactoryReset (All products)

OLD: Keep: LocalSetup/Network/Spark/Provisioning NEW: Keep: LocalSetup/Network/Spark/Provisioning/

SerialPort/Certificates (not in use)

API Reference Guide

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

System status changes in CE9.1

New statuses

RoomAnalytics PeoplePresence

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

/ 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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/ collaboration-endpoints/telepresence-mx-series/ products-release-notes-list.html

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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

System configuration changes in CE9.0

New configurations

Cameras SpeakerTrack Closeup

NetworkServices HTTPS Server MinimumTLSVersion

NetworkServices HTTPS StrictTransportSecurity

NetworkServices UPnP Mode

Configurations that are removed

None

Configurations that are modified

Cameras Camera [n] *

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR

Cameras SpeakerTrack *

OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR

Conference MultiStream Mode

OLD: Value space: Auto/Off NEW: Value space: Off

UserInterface Language

NEW: Portuguese added to value space

xConfigurations with INTEGRATOR user role

A new user role - INTEGR ATOR - is introduced in CE9.0. It has been added to the following configurations:

Audio DefaultVolume

Audio Input HDMI [n] *

Audio Input Line [n] *

Audio Input Microphone [n] *

Audio MicrophoneReinforcement *

Audio Microphones Mute Enabled

Audio Output Line [n] *

Audio SoundsAndAlerts *

Cameras Camera [n] *

Cameras SpeakerTrack *

Conference DefaultCall Rate

Conference DoNotDisturb DefaultTimeout

GPIO Pin [n] Mode

Peripherals Profile *

SerialPort BaudRate

SerialPort Mode

Standby BootAction

Standby Control

Standby Delay

Standby StandbyAction

Standby WakeupAction

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] MonitorRole

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>.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

System command changes in CE9.0

New commands

Audio Microphones ToggleMute

Audio Volume ToggleMute

Audio Sound Play

Audio Sound Stop

Cameras AutoFocus Diagnostics Start

Cameras AutoFocus Diagnostics Stop

SystemUnit SignInBanner Clear

SystemUnit SignInBanner Get

SystemUnit SignInBanner Set

Video Output Monitor Backlight Set

Video Output Monitor Brightness Set

Video Output Monitor Color Blue Set

Video Output Monitor Color Green Set

Video Output Monitor Color Red Set

Video Output Monitor Color Select

Video Output Monitor Contrast Set

Video Output Monitor CSC Select

Video Output Monitor Gamma Set

Video Output Monitor Reset

Video Output Monitor Sharpness 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 Stop

Cameras AutoFocus Diagnostics Start

Cameras AutoFocus Diagnostics Stop

Cameras PresenterTrack ClearPosition

Cameras PresenterTrack Set

Cameras PresenterTrack StorePosition

Cameras SpeakerTrack Diagnostics Start

Peripherals 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

System status changes in CE9.0

New statuses

Cameras PresenterTrack Availability

Cameras PresenterTrack PresenterDetected

Cameras PresenterTrack Status

Video Output Connector [n] ConnectedDevice CEC [n] Name

Video Output Connector [n] ConnectedDevice CEC [n] VendorId

Video Output Monitor [n] Backlight

Video Output Monitor [n] Brightness

Video Output Monitor [n] ColorTemperature Blue

Video Output Monitor [n] ColorTemperature Green

Video Output Monitor [n] ColorTemperature Red

Video Output Monitor [n] ColorTemperature Selected

Video Output Monitor [n] Contrast

Video Output Monitor [n] CSCYUV

Video Output Monitor [n] Gamma

Video Output Monitor [n] Position

Video Output Monitor [n] Sharpness

Statuses that are modified

Diagnostics Message [n] Type

OLD: CAPFOperationState, CTLinstallation, CUCMVendorConfigurationFile,

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



Introduction

API Reference Guide

Call[n] TransmitCallRateCameras 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

Cameras PresenterTrack Availability

Cameras PresenterTrack PresenterDetected

Cameras PresenterTrack Status

Cameras SpeakerTrack Availability

Cameras SpeakerTrack LeftCamera VideoInputConnector

Cameras SpeakerTrack RightCamera VideoInputConnector

Cameras SpeakerTrack Status

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



About the API

API Reference Guide

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Chapter 2

About the API

Cisco TelePresence MX700 and MX800

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:

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:

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>

D15335.08 Cisco TelePresence MX700 and MX800 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.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



About the API

API Reference Guide

RS-232 / serial connection

The video system has a standard COM-port for serial

communication. It can be used without an IP address, DNS or a network. Serial connection is allowed by default.

xConfiguration SerialPort Mode: <Off/On>

Connect a standard 9-pin serial cable <115200, N, 8, 1> to the COM port on the codec.

Baud-rate and other serial port parameters

The serial port uses 8 data bits, no parity and 1 stop bit. The

default baud rate is set to 11520 0 bps.

The codec can give very much feedback. We therefore

recommend keeping the connection at this speed to avoid sluggishness.

You can change the baud rate if required.

xConfiguration SerialPort BaudRate:

<9600/19200/38400/57600/115200>

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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

<Audio>

</Set>

</Volu m e>

</Au d io>

</Command>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

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 237.

Log

The log command is used to enable advanced logs. It is only

used for debugging the system.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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/Scali ng | resultId=”mytag _ 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>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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.

Therefore, you should only subscribe to the feedback

that 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

xFeed back register /Event/CallDisconnect

** end

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

xFeedback list

/Configuration/Video/MainVideoSource

/Event/CallDisconnect

/St a tus/A u d io

** end

xFeed back deregister /Event/CallDisconnect

** end

xFeedback deregister /Status/Audio

** end

xFeedback list

/Configuration/Video/MainVideoSource

** end

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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-add ress>/getxml?location=/Status/Audio

Example 3: Get all configurations of the codec.

http://<ip-address>/getx ml?location=/Configuration

Example 4: Get all video configurations of the codec.

http://<ip-address>/getx ml?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

<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

</Position Set>

</Camera>

</Command>

Response

HTTP/1.1 200 OK

Content-Type: text/xml

Content-Length: 91

<?xml version=”1.0”?>

</Command>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

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>

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

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

<S er v e r U r l > http://127.0.0.1/ myhttpp ostscripturl</ServerUrl>

<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.

<SystemNa me>My System Name</SystemName>

<ProductType>Cisco Codec</ProductType>

<ProductID>Cisco Codec MX800</ProductID>

</Identification>

</Au d io>

</Configuration>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

</Dia l>

</Command>

Example 2: Assigning volume level

Terminal

xCom mand Audio Volume Set Level: 50

XML

<Audio>

</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

<Input>

<InputSourceType>camera</InputSourceType>

</Connector>

</In put >

</Vid eo>

</Configuration>

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



About the API

Dos and don’ts

Here are some best practices when programming the Cisco MX 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration commands

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Chapter 3

Cisco TelePresence MX700 and MX800

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/mx-docs

API Reference Guide

Audio configuration .............................................................................................................................. 43

xConfiguration Audio DefaultVolume

xConfiguration Audio Microphones Mute Enabled

xConfiguration Audio MicrophoneReinforcement Input Microphone [1..8] Mode

xConfiguration Audio MicrophoneReinforcement Output Line [1..4] Mode............................................... 43

xConfiguration Audio MicrophoneReinforcement Gain

xConfiguration Audio SoundsAndAlerts RingTone

xConfiguration Audio SoundsAndAlerts RingVolume

xConfiguration Audio Input HDMI [n] Level

xConfiguration Audio Input HDMI [n] Mode

xConfiguration Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] Equalizer ID

xConfiguration Audio Input Line [1..4] Equalizer Mode

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource

xConfiguration Audio Input Line [1..4] Channel

xConfiguration Audio Input Line [1..4] Level

xConfiguration Audio Input Line [1..4] Mode

xConfiguration Audio Input Microphone [1..8] EchoControl Mode

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation

xConfiguration Audio Input Microphone [1..8] Equalizer ID

xConfiguration Audio Input Microphone [1..8] Equalizer Mode

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource

xConfiguration Audio Input Microphone [1..8] Level

........................................................................................................ 43

.................................................................................... 43

..................................... 43

............................................................................. 44

.................................................................................... 44

............................................................................... 44

................................................................................................ 44

................................................................................................45

..........................................45

.....................................................................................45

.............................................................................. 46

....................................... 46

............................................. 46

......................................................................................... 46

............................................................................................... 47

..............................................................................................47

............................................................. 47

............................................. 47

........................................... 48

....................................................................... 48

................................................................. 48

........................... 48

................................ 49

.................................................................................. 49

xConfiguration Audio Input Microphone [1..8] Mode

xConfiguration Audio Input Microphone [1..8] Type

xConfiguration Audio Output Line [1..6] Channel

xConfiguration Audio Output Line [1..6] Delay DelayMs

xConfiguration Audio Output Line [1..6] Delay Mode

xConfiguration Audio Output Line [1..6] Equalizer ID

xConfiguration Audio Output Line [1..6] Equalizer Mode

xConfiguration Audio Output Line [1..6] Level

xConfiguration Audio Output Line [1..6] Mode

xConfiguration Audio Ultrasound MaxVolume

Cameras configuration

xConfiguration Cameras Camera [1..7] AssignedSerialNumber

xConfiguration Cameras Camera [1..7] Backlight DefaultMode

xConfiguration Cameras Camera [1..7] Brightness Mode

xConfiguration Cameras Camera [1..7] Brightness DefaultLevel

xConfiguration Cameras Camera [n..7] Flip

xConfiguration Cameras Camera [n..7] Focus Mode

xConfiguration Cameras Camera [1..7] Gamma Mode

xConfiguration Cameras Camera [1..7] Gamma Level

xConfiguration Cameras Camera [n..7] Mirror

xConfiguration Cameras Camera [1..7] Whitebalance Mode

xConfiguration Cameras Camera [1..7] Whitebalance Level

xConfiguration Cameras Preset TriggerAutofocus

xConfiguration Cameras SpeakerTrack Mode............................................................................................55

xConfiguration Cameras SpeakerTrack Closeup

......................................................................................................................... 52

................................................................................. 49

.................................................................................. 49

...................................................................................... 50

............................................................................ 50

................................................................................ 50

................................................................................. 50

............................................................................ 51

............................................................................................ 51

........................................................................................... 51

................................................................52

.................................................................52

..........................................................................52

.............................................................. 53

............................................................................................... 53

................................................................................ 53

...............................................................................54

............................................................................................54

.....................................................................54

......................................................................55

.....................................................................................55

.......................................................................................55

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Cameras SpeakerTrack TrackingMode ............................................................................. 56

xConfiguration Cameras SpeakerTrack ConnectorDetection Mode

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight

xConfiguration Cameras SpeakerTrack Whiteboard Mode

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..................................................................................... 59

xConfiguration Conference MaxTotalReceiveCallRate

xConfiguration Conference MaxTotalTransmitCallRate

xConfiguration Conference MultiStream Mode

GPIO configuration

xConfiguration GPIO Pin [1..4] Mode

H323 configuration

xConfiguration H323 Authentication Mode

xConfiguration H323 Authentication LoginName

xConfiguration H323 Authentication Password

xConfiguration H323 CallSetup Mode........................................................................................................61

xConfiguration H323 Encryption KeySize

xConfiguration H323 Gatekeeper Address

xConfiguration H323 H323Alias E164

xConfiguration H323 H323Alias ID

xConfiguration H323 NAT Mode

xConfiguration H323 NAT Address

..................................................................................................................... 57

.........................................................................................57

..........................................................................................57

.........................................................................................57

.......................................................................................57

............................................................................................ 58

........................................................................................... 58

..................................................................................... 58

..................................................................................... 59

.............................................................................. 59

............................................................................. 59

........................................................................................ 60

............................................................................................................................... 60

......................................................................................................... 60

............................................................................................................................... 61

................................................................................................ 61

....................................................................................... 61

......................................................................................... 61

..................................................................................................62

................................................................................................62

........................................................................................................62

.............................................................................................................62

............................................................................................................... 63

........................................................................................................... 63

......................................................... 56

............................................... 56

............................................. 56

....................................................................... 56

....................................................................... 58

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 AnonymousIdentit y

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

xConfiguration Network [1] IPv4 Gateway

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

............................................................................................................................ 64

.....................................................................................................................64

...............................................................................................................64

.......................................................................................................................... 64

.........................................................................................64

.............................................................................................65

........................................................................................65

..........................................................................................65

..................................................................................... 66

....................................................................................... 66

........................................................................................ 66

..........................................................................................67

.......................................................................................67

............................................................................................................67

.............................................................................................67

.................................................................................................. 68

................................................................................................. 68

........................................................................................... 68

............................................................................................ 68

................................................................................................. 69

......................................................................................... 69

............................................................................................................... 69

.......................................................................................................70

.........................................................................................70

......................................................................................... 71

........................................................................................... 71

...................................................................................72

......................................................................................72

...........................................................................................73

......................................................................................73

..............................................................................64

.....................................................................65

...................................................................... 66

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Network [1] Speed .............................................................................................................73

xConfiguration Network [1] VLAN Voice Mode

xConfiguration Network [1] VLAN Voice VlanId

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

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 UPnP Mode

xConfiguration NetworkServices WelcomeText........................................................................................ 80

Peripherals configuration

xConfiguration Peripherals Profile Cameras

xConfiguration Peripherals Profile ControlSystems

xConfiguration Peripherals Profile TouchPanels

............................................................................................................ 74

..................................................................................................................... 80

..........................................................................................74

.......................................................................................... 74

............................................................................................. 74

...........................................................................................74

...........................................................................................75

.............................................................................75

........................................................................75

..........................................................................75

.................................................................................76

......................................................................................76

.....................................................76

.............................................................76

.............................................................77

...............................................................77

.............................................................................................77

.....................................................................77

...............................................................................................78

..........................................................................................78

.....................................................................78

.......................................................................78

..........................................................................79

.........................................................................79

.............................................................................................79

..........................................................................................79

...........................................................................................79

............................................................................................. 80

................................................................................... 81

........................................................................................ 81

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

xConfiguration Proximity Services ContentShare FromClients

xConfiguration Proximity Services ContentShare ToClients

RoomAnalytics configuration................................................................................................................ 86

xConfiguration RoomAnalytics PeoplePresenceDetector

SerialPort configuration

xConfiguration SerialPort Mode

xConfiguration SerialPort BaudRate

xConfiguration SerialPort LoginRequired

SIP configuration

xConfiguration SIP Authentication UserName

xConfiguration SIP Authentication Password

xConfiguration SIP DefaultTransport

......................................................................................................................81

.................................................................................................... 81

................................................................................................ 81

.................................................................................................82

.................................................................................................................... 82

..................................................................................................82

............................................................................................................ 83

................................................................................................... 83

...................................................................................................... 83

...................................................................................................84

.............................................................................84

..............................................................84

.............................................................................84

...................................................................................85

..............................................................................85

......................................................................................................................... 85

..................................................................................................................85

..........................................................................................85

................................................................ 86

..................................................................... 86

........................................................................ 86

........................................................................................................................ 87

.................................................................................................................87

...........................................................................................................87

...................................................................................................87

.................................................................................................................................. 88

.......................................................................................... 88

............................................................................................ 88

......................................................................................................... 88

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration SIP DisplayName .............................................................................................................. 88

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 BootAction

xConfiguration Standby StandbyAction

xConfiguration Standby WakeupAction......................................................................................................92

xConfiguration Standby WakeupOnMotionDetection

xConfiguration Standby PowerSave

SystemUnit configuration

xConfiguration SystemUnit Name

Time configuration

xConfiguration Time TimeFormat

xConfiguration Time DateFormat

xConfiguration Time Zone

xConfiguration Time WorkDay Start

xConfiguration Time WorkDay End

xConfiguration Time WorkWeek FirstDayOfWeek

xConfiguration Time WorkWeek LastDayOfWeek

UserInterface configuration

xConfiguration UserInterface ContactInfo Type

xConfiguration UserInterface CustomMessage

xConfiguration UserInterface KeyTones Mode

xConfiguration UserInterface Language

................................................................................................................................ 93

..................................................................................................................... 89

.................................................................................................. 89

................................................................................................................... 89

.................................................................................................... 89

................................................................................................................. 90

.......................................................................................................... 90

............................................................................................................ 90

.............................................................................................................................. 90

.......................................................................................................................... 91

................................................................................................................. 91

.................................................................................................................... 91

........................................................................................................... 91

.....................................................................................................91

................................................................................92

..........................................................................................................92

..................................................................................................................... 93

..............................................................................................................93

...............................................................................................................93

..........................................................................................................................94

...........................................................................................................95

............................................................................................................95

.................................................................................... 96

.................................................................................................................. 96

........................................................................................ 96

.........................................................................................97

...........................................................................................97

....................................................................................................97

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..5] CameraControl Mode

xConfiguration Video Input Connector [1..5] CameraControl CameraId

xConfiguration Video Input Connector [4] DviType

xConfiguration Video Input Connector [1..5] InputSourceType

xConfiguration Video Input Connector [1..5] Name

xConfiguration Video Input Connector [1..4] PresentationSelection

xConfiguration Video Input Connector [1..5] Quality

xConfiguration Video Input Connector [1..5] Visibility

xConfiguration Video Monitors

xConfiguration Video Output Connector [2] CEC Mode

xConfiguration Video Output Connector [1..3] MonitorRole

xConfiguration Video Output Connector [n] Resolution

xConfiguration Video Presentation DefaultSource...................................................................................105

xConfiguration Video Selfview Default Mode

xConfiguration Video Selfview Default FullscreenMode

xConfiguration Video Selfview Default OnMonitorRole

xConfiguration Video Selfview Default PIPPosition

xConfiguration Video Selfview OnCall Mode

xConfiguration Video Selfview OnCall Duration

.............................................................................................................................101

........................................................................................................... 98

.................................................................................................................103

................................................................................................ 98

................................................................................................ 101

..........................................................................................105

........................................................................................... 107

..............................................................................97

.......................................................................... 98

......................................................................................... 98

......................................................................... 98

................................................................................ 99

................................................................................. 99

................................................................. 99

............................................................. 99

............................................................................. 10 0

........................................................................... 10 0

.................................................................................. 100

........................................................ 101

.................................................. 101

.................................................................................. 101

................................................................102

..................................................................................102

........................................................102

................................................................................103

..............................................................................103

...........................................................................104

.....................................................................104

...........................................................................105

..........................................................................105

............................................................................106

..................................................................................106

....................................................................................... 107

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 Touch controller to change the volume while the video system 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 e faultVo lum e: D efau ltVolu me

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 Microphones 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 MicrophoneReinforcement Input Microphone [1..8] Mode

Set the microphone reinforcement mode individually on each microphone. The signals from all microphones with Mode = On will be mixed and fed to the selected MicrophoneReinforcement outputs. Also consult the Audio MicrophoneReinforcement Output Line Mode setting.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io MicrophoneReinforcement Input Microphone n Mod e: Mode

where

Mode

: Off/On On: The microphone signal will be fed to the selected MicrophoneReinforcement

outputs, as well as to the far end.

Off: The microphone signal will be sent only to the far end. It will not be fed to the selected MicrophoneReinforcement outputs.

xConfiguration Audio MicrophoneReinforcement Output Line [1..4] Mode

Set the microphone reinforcement mode individually on each line output. If Mode = On, the line output will add the microphone reinforcement mix to its ordinary output signal. Also consult the Audio MicrophoneReinforcement Input Microphone Mode setting.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io MicrophoneReinforcement Output Line n M ode: Mode

where

Mode

: Off/On On: This output will deliver far end audio, local presentation audio and the microphone

reinforcement mix.

Off: This output will deliver far end audio and local presentation audio.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio MicrophoneReinforcement Gain

The gain (in dB) that will be applied to the mixed microphone signal that is fed to the selected

MicrophoneReinforcement outputs.

Requires user role: ADMIN, INTEGRATOR Default value: -54

USAGE:

xConfiguration Aud io MicrophoneReinforcement Ga in: Gain

where

Gain

: Integer (-54..15)

Use this gain to adjust the level of microphone signal that should be fed to the local output. The value -54 means "Off", and no signal will be fed from the microphone to the output.

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: 30

USAGE:

xConfiguration Aud io SoundsAndAlerts RingVolu m e: R in 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.

xConfiguration Audio Input HDMI [n] Level

This setting applies to HDMI [2..3] for single camera systems, and to HDMI [3] for dual camera systems.

Define the audio level of the HDMI input connector, in steps of 1 dB.

Requires user role: ADMIN, INTEGRATOR Default value: 0

USAGE:

xConfiguration Aud io Input HDMI n L e v el: Level

where

: Unique ID that identifies the HDMI input. Range: 2..3 for single camera systems; 3..3 for

dual camera systems

Level

: Integer (-24..0)

Select a value between -24 and 0, in steps of 1 dB.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Input HDMI [n] Mode

This setting applies to HDMI [2..3] for single camera systems, and to HDMI [3] for dual camera

systems.

The HDMI inputs have two audio channels. Define if the audio channels on the HDMI input shall

be enabled.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input HDMI n M o d e: Mode

where

: Unique ID that identifies the HDMI input. Range: 2..3 for single camera systems; 3..3 for

dual camera systems

Mode

: Off/On Off: Disable audio on the HDMI input.

On: Enable audio on the HDMI input.

xConfiguration Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo

This setting applies to HDMI [2..3] for single camera systems, and to HDMI [3] for dual camera systems.

Determine whether to play audio only when you present the HDMI input source, or to always play audio when an audio source is connected to the HDMI input.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input HDMI n VideoAssociation MuteOnInactiveVideo:

MuteOnInactiveVideo

where

: Unique ID that identifies the HDMI input. Range: 2..3 for single camera systems; 3..3 for

dual camera systems

MuteOnInactiveVideo

Off: Audio is always played, locally and to far end; you do not have to present the HDMI input source.

On: Audio is played, locally and to far end, only when you present the HDMI input

source.

: Off/On

xConfiguration Audio Input Line [1..4] Equalizer ID

Select the equalizer ID of the audio source that is connected to the line input.

Requires user role: ADMIN, INTEGRATOR Default value: 1

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

USAGE:

xConfiguration Aud io Input Line n Eq ualizer ID: ID

where

: Unique ID that identifies the audio line input. Range: 1..4

: Integer (1..8)

Set the equalizer ID.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Input Line [1..4] Equalizer Mode

Define the equalizer mode for the audio source that is connected to the line input.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io Input Line n Eq ualizer M o d e: Mode

where

: Unique ID that identifies the audio line input. Range: 1..4

Mode

: Off/On Off: No equalizer.

On: Enable the equalizer for the audio source that is connected to the line input.

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo

The audio source can be associated with a video source on the video input connector, and

you can determine whether to play or mute audio depending on whether the video source is presented or not.

Requires user role: ADMIN, INTEGRATOR Default value: Line [1, 2]: On Line[3, 4]: Off

USAGE:

xConfiguration Aud io Input Line n VideoAssociation MuteOnInactiveVideo:

MuteOnInactiveVideo

where

: Unique ID that identifies the audio line input. Range: 1..4

MuteOnInactiveVideo

Off: The audio source is not associated with a video source. The audio will be played locally and to far end regardless of whether the video source is presented.

On: The audio source is associated with a video source. The audio will be played (locally and to far end) when the associated video source is presented. The audio will be muted when the video source is not presented.

: Off/On

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource

The audio source can be associated with a video source on the video input connector.

Requires user role: ADMIN, INTEGRATOR Default value: Line [1, 2]: 4 Line[3, 4]: 1

USAGE:

xConfiguration Aud io Input Line n VideoAssociation VideoInputSource:

VideoInp ut So urc e

where

: Unique ID that identifies the audio line input. Range: 1..4

VideoInp ut So urc e

Select the video input connector to associate the audio source with.

: 1/2/3/4/5

xConfiguration Audio Input Line [1..4] Channel

Define whether the audio source on the line input is a mono signal or part of a multichannel signal.

Requires user role: ADMIN, INTEGRATOR Default value: Left

USAGE:

xConfiguration Aud io Input Line n C h a nnel: Channel

where

: Unique ID that identifies the audio line input. Range: 1..4

Channel

: Left/Mono/Right

Left: The Audio Line input signal is the left channel of a stereo signal.

Mono: The Audio Line input signal is a mono signal.

Right: The Audio Line input signal is the right channel of a stereo signal.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Input Line [1..4] Level

Define the level of the audio source on the line input connector. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a

complete over view of the values represented in dB.

Requires user role: ADMIN, INTEGRATOR Default value: 10

USAGE:

xConfiguration Aud io Input Line n L e v el: Level

where

: Unique ID that identifies the audio line input. Range: 1..4

Level

: Integer (0..24)

Select a value between 0 and 24, in steps of 1 dB.

xConfiguration Audio Input Line [1..4] Mode

Define the mode for the audio input line.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input Line n M o d e: Mode

where

: Unique ID that identifies the audio line input. Range: 1..4

Mode

: Off/On Off: Disable the Audio Line input.

On: Enable the Audio Line input.

xConfiguration Audio Input Microphone [1..8] EchoControl Mode

The echo canceller continuously adjusts itself to the audio characteristics of the room, and compensates for any changes it detects in the audio environment. If the changes in the audio conditions are significant, the echo canceller may take a second or two to re-adjust.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input Microphone n EchoControl Mode: Mode

where

: Unique ID that identifies the microphone input. Range: 1..8

Mode

: Off/On Off: Turn off the echo control. Recommended if external echo cancellation or playback

equipment is used.

On: Turn on the echo control. Recommended, in general, to prevent the far end from hearing their own audio. Once selected, echo cancellation is active at all times.

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction

The system has built-in noise reduction, which reduces stationary background noise, for example noise from air-conditioning systems, cooling fans etc. In addition, a high pass filter (Humfilter) reduces very low frequency noise. Noise reduction requires that Audio Input Microphone [n] EchoControl Mode is enabled.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input Microphone n EchoControl NoiseReduction:

NoiseReduction

where

: Unique ID that identifies the microphone input. Range: 1..8

NoiseReduction

Off: Turn off the noise reduction.

On: Turn on the noise reduction. Recommended in the presence of low frequency noise.

: Off/On

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation

The system has built-in signal processing to reduce the effect of room reverberation.

Dereverberation requires that Audio Input Microphone [n] EchoControl Mode is enabled.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io Input Microphone n EchoControl Dereverberation:

Dereverberation

where

: Unique ID that identifies the microphone input. Range: 1..8

Dereverberation

Off: Turn off the dereverberation.

On: Turn on the dereverberation.

: Off/On

xConfiguration Audio Input Microphone [1..8] Equalizer ID

Select the equalizer ID of the source that is connected to the microphone input.

Requires user role: ADMIN, INTEGRATOR Default value: 1

USAGE:

xConfiguration Aud io Input Microphone n Equalizer ID: ID

where

: Unique ID that identifies the microphone input. Range: 1..8

: Integer (1..8)

Set the equalizer ID.

xConfiguration Audio Input Microphone [1..8] Equalizer Mode

Define the equalizer mode for the source that is connected to the microphone input.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io Input Microphone n Equalizer Mo d e: Mode

where

: Unique ID that identifies the microphone input. Range: 1..8

Mode

: Off/On Off: No equalizer.

On: Enable the equalizer for the source that is connected to the microphone input.

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo

The microphone can be associated with a video source on the video input connector, and you can determine whether to play or mute audio depending on whether the video source is presented or not. By default, audio is not muted.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input Microphone n VideoAssociation MuteOnInactiveVideo:

MuteOnInactiveVideo

where

: Unique ID that identifies the microphone input. Range: 1..8

MuteOnInactiveVideo

Off: No video source is associated.

On: A video source is associated, and the audio will be muted if the associated video

source is not displayed.

: Off/On

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource

Select the video input connector to associate the audio source with.

Requires user role: ADMIN, INTEGRATOR Default value: 1

USAGE:

xConfiguration Aud io Input Microphone n VideoAssociation VideoInputSource:

VideoInp ut So urc e

where

: Unique ID that identifies the microphone input. Range: 1..8

VideoInp ut So urc e

Select the video input connector to associate the audio source with.

: 1/2/3/4/5

xConfiguration Audio Input Microphone [1..8] Level

Define the level of the Microphone input connector. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a

complete over view of the values represented in dB.

Requires user role: ADMIN, INTEGRATOR Default value: 58

USAGE:

xConfiguration Aud io Input Microphone n Level: Level

where

: Unique ID that identifies the microphone input. Range: 1..8

Level

: Integer (0..70)

Select a value between 0 and 70, in steps of 1 dB.

xConfiguration Audio Input Microphone [1..8] Mode

Disable or enable audio on the microphone connector.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Input Microphone n Mode: Mode

where

: Unique ID that identifies the microphone input. Range: 1..8

Mode

: Off/On Off: Disable the audio input microphone connector.

On: Enable the audio input microphone connector.

xConfiguration Audio Input Microphone [1..8] Type

The microphone connectors are intended for electret type microphones. The microphone connector can be set to line or microphone mode.

Requires user role: ADMIN, INTEGRATOR Default value: Microphone

USAGE:

xConfiguration Aud io Input Microphone n Ty p e: Type

where

: Unique ID that identifies the microphone input. Range: 1..8

Type

: Line/Microphone

Microphone: Select Microphone when you have 48 V Phantom voltage and the pre-amplification is On.

Line: Select Line when you have a standard balanced line input. The phantom voltage

and pre-amplification is Off.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Output Line [1..6] Channel

Define whether the Audio Line output is a mono signal or part of a multichannel signal.

Requires user role: ADMIN, INTEGRATOR Default value: Left

USAGE:

xConfiguration Aud io Output Line n C h an n e l: Channel

where

: Unique ID that identifies the audio line output. Range: 1..6

Channel

: Left/Mono/Right

Left: The Audio Line output signal is the left channel of a stereo signal.

Mono: The Audio Line output signal is a mono signal.

Right: The Audio Line output signal is the right channel of a stereo signal.

xConfiguration Audio Output Line [1..6] Delay DelayMs

To obtain lip-synchronization, you can configure each audio line output with an extra delay that

compensates for delay in other connected devices, for example TVs and external loudspeakers. The delay that you set here is either fixed or relative to the delay on the HDMI output, as defined in the Audio Output Line [n] Delay Mode setting.

Requires user role: ADMIN, INTEGRATOR Default value: 0

USAGE:

xConfiguration Aud io Output Line n Delay DelayMs: DelayMs

where

: Unique ID that identifies the audio line output. Range: 1..6

DelayMs

: Integer (0..290)

The delay in milliseconds.

xConfiguration Audio Output Line [1..6] Delay Mode

You may add extra delay to an audio line output with the Audio Output Line [n] Delay DelayMs setting. The extra delay added is either a fixed number of milliseconds, or a number of milliseconds relative to the detected delay on the HDMI output (typically introduced by the connected TV).

Requires user role: ADMIN, INTEGRATOR Default value: Fixed

USAGE:

xConfiguration Aud io Output Line n Delay Mode: Mode

where

: Unique ID that identifies the audio line output. Range: 1..6

Mode

: Fixed/RelativeToHDMI Fixed: Any extra delay (DelayMs) added to the output, will be a fixed number of

millisecond.

RelativeToHDMI: Any extra delay (DelayMs) added to the output, will be relative to the detected delay on the HDMI output. The actual delay is HDMI-delay + DelayMs. The Audio Output Connectors Line [n] DelayMs status reports the actual delay.

xConfiguration Audio Output Line [1..6] Equalizer ID

Select the equalizer ID for the audio source that is connected to the output line.

Requires user role: ADMIN, INTEGRATOR Default value: 1

USAGE:

xConfiguration Aud io Output Line n Equalizer ID: ID

where

: Unique ID that identifies the audio line output. Range: 1..6

: Integer (1..8)

Set the equalizer ID.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Audio Output Line [1..6] Equalizer Mode

Define the equalizer mode for the audio source that is connected to the output line.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Aud io Output Line n Equalizer Mode: Mode

where

: Unique ID that identifies the audio line output. Range: 1..6

Mode

: Off/On Off: No equalizer.

On: Enable the equalizer for the audio output line.

xConfiguration Audio Output Line [1..6] Level

Define the audio level on the line output connector. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a

complete over view of the values represented in dB.

Requires user role: ADMIN, INTEGRATOR Default value: -10

USAGE:

xConfiguration Aud io Output Line n L e v e l: Level

where

: Unique ID that identifies the audio line output. Range: 1..6

Level

: Integer (-24..0)

Select a value between -24 and 0, in steps of 1 dB.

xConfiguration Audio Output Line [1..6] Mode

Define the mode for the audio line output.

Requires user role: ADMIN, INTEGRATOR Default value: On

USAGE:

xConfiguration Aud io Output Line n M o de: Mode

where

: Unique ID that identifies the audio line output. Range: 1..6

Mode

: Off/On

Off: Disable the audio line output.

On: Enable the audio line output.

xConfiguration Audio Ultrasound MaxVolume

This setting applies to the Intelligent Proximity feature. Set the maximum volume of the ultrasound pairing message.

Requires user role: ADMIN, INTEGRATOR Default value: 70

USAGE:

xConfiguration Aud io Ultrasound M a xVolu m e: MaxVolume

where

Ma xVolu m e

: Integer (0..90)

Select a value in the specified range. If set to 0, the ultrasound is switched off.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

Cameras configuration

xConfiguration Cameras Camera [1..7] AssignedSerialNumber

The camera ID is the number n in Camera [n]. By default, the camera ID is assigned automati-

cally to a camera. If EDID information is not passed on from the camera to the codec, the camera ID is not persistent after a reboot. This means that a camera may get a new camera ID when the codec (video system) is restarted.

You should use the Cameras Camera AssignedSerialNumber setting to cater for configurations where the codec does not receive EDID information from multiple cameras. This setting allows you to manually assign a camera ID to a camera by associating the camera ID with the camera's serial number. The setting is persistent until the codec is factory reset.

Typical situations where the codec does not receive EDID information are: when you connect

a Cisco TelePresence Precision 60 camera using 3G-SDI; when you connect a Cisco

TelePresence Precision 40 (Cisco TelePresence PrecisionHD 1080p4xS2) camera; when you

use an HDMI repeater that does not pass on EDID information.

The default value is an empty string.

Requires user role: ADMIN, INTEGRATOR Default value: ""

USAGE:

xConfiguration Cameras Camera n AssignedSerialNumber: "AssignedSerialNum ber"

where

: Unique ID that identifies the camera. Range: 1..7

AssignedSerialNum ber

The camera's serial number.

: String (0, 20)

xConfiguration Cameras Camera [1..7] Backlight DefaultMode

This configuration turns backlight compensation on or off. Backlight compensation is useful when there is much light behind the persons in the room. Without compensation the persons will easily appear very dark to the far end.

Requires user role: ADMIN, INTEGRATOR Default value: Off

USAGE:

xConfiguration Cameras Camera n Backlight Default M o d e: DefaultMode

where

: Unique ID that identifies the camera. Range: 1..7

DefaultMode

: Off/On

Off: Turn off the camera backlight compensation.

On: Turn on the camera backlight compensation.

xConfiguration Cameras Camera [1..7] Brightness Mode

Define the camera brightness mode.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n Brightness M o de: Mode

where

: Unique ID that identifies the camera. Range: 1..7

Mode

: Auto/Manual Auto: The camera brightness is automatically set by the system.

Manual: Enable manual control of the camera brightness. The brightness level is set

using the Cameras Camera [n] Brightness DefaultLevel setting.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Cameras Camera [1..7] Brightness DefaultLevel

Define the brightness level. Requires the Cameras Camera [n] Brightness Mode to be set to Manual.

Requires user role: ADMIN, INTEGRATOR Default value: 20

USAGE:

xConfiguration Cameras Camera n Brightness D ef ault L e v e l: D efault Lev el

where

: Unique ID that identifies the camera. Range: 1..7

Defau ltLe vel

The brightness level.

: Integer (1..31)

xConfiguration Cameras Camera [n..7] Flip

This setting applies to Camera [2..7] for single camera systems, and to HDMI [3..7] for dual

camera systems. With Flip mode (vertical flip) you can flip the image upside down. Flipping applies both to the

self-view and the video that is transmitted to the far end.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n Fli p: Flip

where

: Unique ID that identifies the camera. Range: 2..7 for single camera systems; 3..7 for dual

camera systems

Flip

: Auto/Off/On

Auto: If the camera detects that it is mounted upside down, the image is automatically flipped. If the camera cannot auto-detect whether it is mounted upside down or not, the image is not changed.

Off: Display the image on screen the normal way.

On: Display the image flipped upside down. This setting is used when a camera is mounted upside down, but cannot automatically detect which way it is mounted.

xConfiguration Cameras Camera [n..7] Focus Mode

Define the camera focus mode.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n Focus Mode: Mode

where

: Unique ID that identifies the camera. Range: 2..7 for single camera systems; 3..7 for dual

camera systems

Mode

: Auto/AutoLimited/Manual Auto: The camera will do continuous auto focusing. It will, more specifically, run auto

focus once a call is connected, after moving the camera (pan, tilt, zoom), and generally

when the camera identifies a change in the scene.

AutoLimited: In most cases this mode will operate the same way as Auto. In some cases AutoLimited will reduce the focus hunting that may occur. Problematic scenes have

large areas with no or low contrast, for instance a painted wall with no details, or maybe a partly empty whiteboard. There’s a slightly higher chance of background focus with

this mode, compared to Auto.

Manual: Turn the autofocus off and adjust the camera focus manually.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Cameras Camera [1..7] Gamma Mode

This setting enables gamma corrections, and applies only to cameras which support gamma

mode. Gamma describes the nonlinear relationship between image pixels and monitor brightness.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n Gam ma Mode: Mode

where

: Unique ID that identifies the camera. Range: 1..7

Mode

: Auto/Manual Auto: Auto is the default and the recommended setting.

Manual: In manual mode the gamma value is changed with the gamma level setting, ref. Cameras Camera [n] Gamma Level.

xConfiguration Cameras Camera [1..7] Gamma Level

By setting the Gamma Level you can select which gamma correction table to use. This setting may be useful in difficult lighting conditions, where changes to the brightness setting does not provide satisfactory results. Requires the Cameras Camera [n] Gamma Mode to be set to Manual.

Requires user role: ADMIN, INTEGRATOR Default value: 0

USAGE:

xConfiguration Cameras Camera n Gam ma Level: Level

where

: Unique ID that identifies the camera. Range: 1..7

Level

: Integer (0..7)

Define the gamma level.

xConfiguration Cameras Camera [n..7] Mirror

This setting applies to Camera [2..7] for single camera systems, and to HDMI [3..7] for dual camera systems.

With Mirror mode (horizontal flip) you can mirror the image on screen. Mirroring applies both to the self-view and the video that is transmitted to the far end.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n Mirr or: Mirror

where

: Unique ID that identifies the camera. Range: 2..7 for single camera systems; 3..7 for dual

camera systems

Mirror

: Auto/Off/On

Auto: If the camera detects that it is mounted upside down, the image is automatically

mirrored. If the camera cannot auto-detect whether it is mounted upside down or not,

the image is not changed.

Off: Display the image as other people see you.

On: Display the image as you see yourself in a mirror.

xConfiguration Cameras Camera [1..7] Whitebalance Mode

Define the camera white balance mode.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras Camera n White b ala nce M o d e: Mode

where

: Unique ID that identifies the camera. Range: 1..7

Mode

: Auto/Manual Auto: The camera will continuously adjust the white balance depending on the camera

view.

Manual: Enables manual control of the camera white balance. The white balance level is set using the Cameras Camera [n] Whitebalance Level setting.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Cameras Camera [1..7] Whitebalance Level

Define the white balance level. Requires the Cameras Camera [n] Whitebalance Mode to be set to manual.

Requires user role: ADMIN, INTEGRATOR Default value: 1

USAGE:

xConfiguration Cameras Camera n White b ala nce L e v e l: Level

where

: Unique ID that identifies the camera. Range: 1..7

Level

: Integer (1..16)

The white balance level.

xConfiguration Cameras Preset TriggerAutofocus

The current position (pan and tilt), zoom and focus are stored with a preset. Use this setting to

determine if the camera should refocus or use the focus value that is stored with the preset.

Requires user role: ADMIN Default value: Auto

USAGE:

xConfiguration Cameras Preset TriggerAutofocus: TriggerAutofocus

where

TriggerAutofocus

Auto: Whether the camera refocuses or not when selecting a preset, depends on the camera type.

Off: The focus value that is stored with the preset will be used. The camera will not refocus when selecting a preset.

On: The camera will refocus when selecting a preset. The focus value that is stored with the preset may be overridden.

: Auto/Off/On

xConfiguration Cameras SpeakerTrack Mode

This setting applies only to systems with dual cameras. The dual camera assembly consists of two cameras and uses an audio tracking technique that

finds and captures a close-up of the active speaker. When a change of speaker is detected, the system can switch automatically between the two cameras to always show the best camera view. Refer to the Cameras SpeakerTrack TrackingMode setting for different switching modes.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras SpeakerTrack M o d e: Mode

where

Mode

: Auto/Off Auto: Speaker tracking is switched on. The system will detect people in the room and

automatically select the best camera framing. Users can switch speaker track on or off

instantly in the camera control panel on the Touch controller.

Off: Speaker tracking is switched off, and the two cameras operate as individual cameras.

xConfiguration Cameras SpeakerTrack Closeup

This setting applies only when the Cameras SpeakerTrack Mode is set to Auto. When a person in the room speaks the system will find the person and select the best camera

framing. This is called a closeup and may not include all the persons in the room. If you want all the persons in the room to be in the picture at all times you can turn off the closeup functionality.

Requires user role: ADMIN, INTEGRATOR, USER Default value: Auto

USAGE:

xConfiguration Cameras SpeakerTrack Closeup: Closeu p

where

Closeu p

: Auto/Off

Auto: The system will zoom in on the person speaking.

Off: The system will keep all the persons in the room in the camera framing at all times.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Cameras SpeakerTrack TrackingMode

This setting applies only to systems with a dual camera (speaker tracking), and when Cameras

SpeakerTrack Mode is set to Auto.

The speaker tracking algorithm can react to changes in two modes, one faster than the other. The mode determines when the camera view will change to a new speaker.

Requires user role: ADMIN, INTEGRATOR Default value: Auto

USAGE:

xConfiguration Cameras SpeakerTrack TrackingMode: TrackingMode

where

TrackingMode

Auto: Normal tracking mode.

Conservative: The camera view will change to a new speaker later than in Normal mode.

: Auto/Conservative

xConfiguration Cameras SpeakerTrack ConnectorDetection Mode

Not applicable in this version.

USAGE:

xConfiguration Cameras SpeakerTrack ConnectorDetection Mod e: Mode

where

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft

Not applicable in this version.

xConfiguration Cameras SpeakerTrack Whiteboard Mode

This setting applies only to systems with dual cameras. The Snap to Whiteboard feature extends the speaker tracking functionality, thus you need a

camera that suppor ts speaker tracking. When a presenter is standing next to the whiteboard, the camera will capture both the presenter and the whiteboard if the Snap to Whiteboard feature is enabled. If the feature is disabled, only the presenter will be captured. The Snap to Whiteboard feature is set up from the Touch controller or web interface.

Requires user role: ADMIN, INTEGRATOR, USER Default value: Off

USAGE:

xConfiguration Cameras SpeakerTrack W hite b o ard M o d e: Mode

where

Mode

: Off/On

Off: The Snap to Whiteboard feature is disabled.

On: The Snap to Whiteboard feature is enabled.

USAGE:

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft: CameraLeft

where

xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight

Not applicable in this version.

USAGE:

xConfiguration Cameras SpeakerTrack ConnectorDetection Ca m e ra R igh t: Ca m eraR ight

where

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 o d e: Mode

where

Mode

: Off/On Off: You must answer incomming calls manually by tapping Answer on the Touch

controller.

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 u te: Mute

where

Mute

: Off/On Off: The incoming call will not be muted.

On: The incoming call will be muted when automatically answered.

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 Pr o toc 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; 3) H320. If the system cannot register, the auto-selection chooses H323.

H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link).

H323: All calls are set up as H.323 calls.

Sip: All calls are set up as SIP calls.

Spark: Reserved for Spark registered systems. Do not use.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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: 6000

USAGE:

xConfiguration Conference DefaultCall Rat e: Rate

where

Rat e

: Integer (64..6000) 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 faultTi m e o u t

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)

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

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.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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: 6000

USAGE:

xConfiguration Conference MaxReceiveCallRate: MaxReceiveCallRate

where

MaxReceiveCallRate

The maximum receive call rate (kbps).

: Integer (64..6000)

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: 6000

USAGE:

xConfiguration Conference MaxTransmitCallRate: MaxTransmitCallRate

where

MaxTransmitCallRate

The maximum transmitt call rate (kbps).

: Integer (64..6000)

xConfiguration Conference MaxTotalReceiveCallRate

This configuration applies when using a video system's built-in MultiSite feature (optional) to host a multipoint video conference.

Define the maximum overall receive bit rate allowed. The bit rate will be divided fairly among all active calls at any time. This means that the individual calls will be up-speeded or downspeeded as appropriate when someone leaves or enters a multipoint conference, or when a call is put on hold (suspended) or resumed.

The maximum receive bit rate for each individual call is defined in the Conference MaxReceiveCallRate setting.

Requires user role: ADMIN Default value: 6000

USAGE:

xConfiguration Conference MaxTotalReceiveCallRate: MaxTotalReceiveCallRate

where

MaxTotalReceiveCallRate

The maximum receive call rate (kbps).

: Integer (64..6000)

xConfiguration Conference MaxTotalTransmitCallRate

This configuration applies when using a video system's built-in MultiSite feature (optional) to host a multipoint video conference.

Define the maximum overall transmit bit rate allowed. The bit rate will be divided fairly among all active calls at any time. This means that the individual calls will be up-speeded or downspeeded as appropriate when someone leaves or enters a multipoint conference, or when a call is put on hold (suspended) or resumed.

The maximum transmit bit rate for each individual call is defined in the Conference MaxTransmitCallRate setting.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Requires user role: ADMIN Default value: 6000

USAGE:

xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate

where

MaxTotalTransmitCallRate

The maximum transmit call rate (kbps).

: Integer (64..6000)

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Conference MultiStream Mode

The video system supports multistream video for conferences.

Requires user role: ADMIN Default value: Auto

USAGE:

xConfiguration Conference MultiStream M o de: Mode

where

Mode

: Auto/Off Auto: Multistream will be used when the conference infrastructure supports the feature.

Minimum versions required: CMS 2.2, CUCM 11.5, VCS X8.7.

Off: Multistream is disabled.

GPIO configuration

xConfiguration GPIO Pin [1..4] Mode

The four GPIO pins are configured individually. The state can be retrieved by xStatus GPIO Pin

[1..4] State. The default pin state is High (+12 V). When activated as an output, a pin is set to 0 V (Low); when deactivated, it is set to +12 V (High). To activate a pin as an input, the voltage on the pin must be pulled down to 0 V; to deactivate it, raise the voltage to +12 V.

Requires user role: ADMIN, INTEGRATOR Default value: InputNoAction

USAGE:

xConfiguration GPIO Pin n Mode: Mode

where

: GPIO pin number. Range: 1..4

Mode

: InputAcceptAllCalls/InputDisconnectAllCalls/InputMuteMicrophones/InputNoAction/ OutputAllCallsEncrypted/OutputInCall/OutputManualState/OutputMicrophonesMuted/ OutputPresentationOn/OutputStandbyActive

InputAcceptAllCalls: When the pin is activated, the xCommand Call Accept command,

which accepts all incoming calls, will be issued.

InputDisconnectAllCalls: When the pin is activated, the xCommand Call Disconnect

command, which disconnects all calls, will be issued.

InputMuteMicrophones: When the pin is activated, the microphones will be muted.

When deactivated, the microphones will be unmuted.

InputNoAction: The pin state can be set, but no operation is performed.

Output AllCallsEncrypted: The pin is activated when all calls are encrypted, and deacti-

vated when one or more calls are not encr ypted.

OutputInCall: The pin is activated when in call, and deactivated when not in call.

OutputManualState: The pin state can be set by xCommand GPIO ManualState Set

PinX: <High/Low>. It is set to +12 V or 0 V, respectively.

OutputMicrophonesMuted: The pin is activated when microphones are muted, and

deacti¬vated when not muted.

OutputPresentationOn: The pin is activated when presentation is active, and deacti-

vated when presentation is not active.

OutputStandbyActive: The pin is activated when the system is in standby mode, and

deacti¬vated when no longer in standby.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 Mod 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: ""

USAGE:

xConfiguration H323 Authentication LoginNa m e: "LoginName"

where

LoginNa me

: String (0, 50)

The authentication login name.

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 Mode: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 d ress: "Address"

where

Address

: String (0, 255)

A valid IPv4 address, IPv6 address or DNS name.

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 H323Alias 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 H323Alias ID: "ID"

where

: String (0, 49)

The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID"

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 Mo 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 startupmenu 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.

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 Ad d ress: "Address"

where

Address

: String (0, 64)

A valid IPv4 address or IPv6 address.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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.

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.

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 N a me: "Name"

where

: 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 dr ess: "Address"

where

: Index that identifies the network. Range: 1..1

: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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

: 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: TlsVerify

where

: 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.

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

: 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: "Identity "

where

: Index that identifies the network. Range: 1..1

Ide ntity

: String (0, 64)

The user name for 802.1X authentication.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Network [1] IEEE8021X Password

Define the password for 802.1X authentication.

Requires user role: ADMIN, USER Default value: ""

USAGE:

xConfiguration Network n IEEE8021X Pass word: "Password"

where

: 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 Anony mousIde ntity: "AnonymousIdentity"

where

: Index that identifies the network. Range: 1..1

AnonymousIdentity

The 802.1X Anonymous ID string.

: String (0, 64)

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

: 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

: 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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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

: 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 Peap: Peap

where

: 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).

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 IPStack: IP Stac k

where

: 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 n m e nt: A ssign m ent

where

: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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: "Add ress"

where

: 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

: Index that identifies the network. Range: 1..1

Gate way

: String (0, 64)

A valid IPv4 address.

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: "SubnetM ask"

where

: 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

: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 r es s: "Address"

where

: 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: "Gate way"

where

: Index that identifies the network. Range: 1..1

Gate way

: String (0, 64)

A valid IPv6 address.

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

: 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

: Index that identifies the network. Range: 1..1

MTU

: Integer (576..1500)

Set a value for the MTU (bytes).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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

: 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.

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 Au dio: Aud io

where

: 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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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: Video

where

: 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).

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: D ata

where

: 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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 realtime 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 na lling

where

: 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).

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 M P v6

where

: 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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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

: 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.

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

: 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.

Requires user role: ADMIN, USER

Default value: ""

USAGE:

xConfiguration Network n RemoteAccess Allo w: "Allow"

where

: Index that identifies the network. Range: 1..1

Allow

: String (0, 255)

A valid IPv4 address or IPv6 address.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 Voic e Mode: Mode

where

: 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

USAGE:

xConfiguration Network n VLAN Voic e VlanId: VlanId

where

: Index that identifies the network. Range: 1..1

VlanId

: Integer (1..4094)

Set the VLAN voice ID.

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 o de: 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 Mo 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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 M o de: 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 LoginNa 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 Allowed: Allowed

where

Allowed

D15335.08 Cisco TelePresence MX700 and MX800 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.

Cisco TelePresence MX700 and MX800

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 Mo 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 inimu m TLS Version: M inimu 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 reference time server. The time server will be queried regularly for time updates.

Requires user role: ADMIN Default value: Auto

USAGE:

xConfiguration NetworkServices NTP M ode: 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

: Unique ID that identifies the NTP server. Range: 1..3

Address

: String (0, 255)

A valid IPv4 address, IPv6 address or DNS name.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 Mode: 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 Mode: 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

: 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 m unityNa m e: "CommunityName"

where

CommunityName

The SNMP community name.

: String (0, 50)

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 stemCont 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.

Requires user role: ADMIN

Default value: On

USAGE:

xConfiguration NetworkServices SSH M o d e: Mode

where

Mode

: Off/On Off: The SSH protocol is disabled.

On: The SSH protocol is enabled.

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 UPnP Mode

Fully disable UPnP (Universal Plug and Play), or enable UPnP for a short time period after the video system has been switched on or restarted.

The default operation is that UPnP is enabled when you switch on or restart the video system. Then UPnP is automatically disabled after the timeout period that is defined in the NetworkServices UPnP Timeout setting. Use the video system’s web interface to set the timeout.

When UPnP is enabled, the video system advertises its presence on the network. The advertisement permits a Touch controller to discover video systems automatically, and you do not need to manually enter the video system's IP address in order to pair the Touch controller.

Requires user role: ADMIN Default value: On

USAGE:

xConfiguration NetworkServices UPnP M o d e: Mode

where

Mode

: <Off/On> Off: UPnP is disabled. The video system does not advertise its presence, and you have

to enter the video system's IP address manually in order to pair a Touch controller to the video system.

On: UPnP is enabled. The video system advertises its presence until the timeout period

expires.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 Welc 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

Peripherals configuration

xConfiguration Peripherals Profile Cameras

Define the number of cameras that are expected to be connected to the video system. This information is used by the video system's diagnostics service. If the number of connected cameras does not match this setting, the diagnostics service will report it as an inconsistency.

Requires user role: ADMIN, INTEGRATOR Default value: Minimum1

USAGE:

xConfiguration Peripherals Profile Ca m era s: Cameras

where

Cameras

: N o t S et/Min i m u m1/0/1/ 2/3/4 /5/ 6/7

NotSet: No camera check is performed.

Minimum1: At least one camera should be connected to the video system.

0-7: Select the number of cameras that are expected to be connected to the video

system.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 diagnos-

tics 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

xConfiguration Peripherals Profile TouchPanels

Define the number of Cisco Touch controllers that are expected to be connected to the video

system. This information is used by the video system's diagnostics service. If the number of

connected Touch controllers does not match this setting, the diagnostics service will report it

as an inconsistency.

Requires user role: ADMIN, INTEGRATOR

Default value: Minimum1

USAGE:

xConfiguration Peripherals Profile TouchPanels: TouchPanels

where

TouchPanels

NotSet: No touch panel check is performed.

Minimum1: At least one Cisco Touch controller should be connected to the video system.

0-5: Select the number of Touch controllers that are expected to be connected to the video system. Note that only one Cisco Touch controller is officially supported.

: N o t S et/Min i m u m1/0/1/ 2/3/4 /5

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

: Unique ID that identifies the phonebook server. Range: 1..1

: 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

: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

: 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 simultane-

ously. 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 LoginNa 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 Password: "Password"

where

Password

: String (0, 64)

A valid password.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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: HttpMethod

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 A d 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 Prot o c o l: Protocol

where

Protocol

: HTTPS/HTTP

HTTPS: Send requests via HT TPS.

HTTP: Send requests via HTTP.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 Path: "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: On

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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Requires user role: ADMIN, USER Default value: Disabled

USAGE:

xConfiguration Proximity Services CallControl: Ca llCo nt rol

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.

Cisco TelePresence MX700 and MX800

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: Fro mClients

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 ser vice 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.

RoomAnalytics configuration

xConfiguration RoomAnalytics PeoplePresenceDetector

The video system has the capability to find whether or not people are present in the room, and report the result in the RoomAnalytics PeoplePresence status. This feature is based on ultrasound. It takes a minimum of 2 minutes to detect whether people are present or not in the room, and it may take up to 2 minutes for the status to change after the room becomes vacant.

Requires user role: ADMIN, INTEGRATOR, USER Default value: Off

USAGE:

xConfiguration Roo m A n aly t ics PeoplePresenceDetector: PeoplePresenceDetector

where

PeoplePresenceDetector

Off: The video system's status does not show whether or not there are people present in the room.

On: The video system's status shows whether or not there are people present in the room.

: Off/On

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

SerialPort configuration

xConfiguration SerialPort Mode

Enable/disable the serial port (COM port).

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 BaudRate

Define the baud rate (data transmission rate, bits per second) for the serial port.

Other connection parameters for the serial port are: Data bits: 8; Parity: None; Stop bits: 1; Flow

control: None.

Requires user role: ADMIN, INTEGRATOR

Default value: 115200

USAGE:

xConfiguration SerialPort BaudRate: BaudR ate

where

Bau dRate

: 9600/19200/38400/57600/115200

Set a baud rate from the baud rates listed (bps).

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: LoginReq uired

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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: "UserName"

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 Passwor d: "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 e fau ltTranspor t: D efau ltTrans p ort

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)

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 Mode: 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 ress: "Address"

where

: 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.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

: String (0, 128)

A valid password.

Cisco TelePresence MX700 and MX800

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: Control

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 BootAction

Define the camera position after a restart of the codec.

Requires user role: ADMIN, INTEGRATOR, USER Default value: DefaultCameraPosition

USAGE:

xConfiguration Standby Boot A ction: BootAction

where

BootA ction

: None/DefaultCameraPosition/RestoreCameraPosition

None: No action.

RestoreCameraPosition: When the video system restarts, the camera returns to the position that it had before the restart.

DefaultCameraPosition: When the video system restarts, the camera moves to the factory default position.

xConfiguration Standby StandbyAction

Define the camera position when going into standby mode.

Requires user role: ADMIN, INTEGRATOR Default value: PrivacyPosition

USAGE:

xConfiguration Standby Sta n d byAct ion: St and byA c tion

where

Sta nd byA ct ion

None: No action.

PrivacyPosition: When the video system enters standby, the camera turns to a sideways position for privacy.

: None/PrivacyPosition

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Standby WakeupAction

Define the camera position when leaving standby mode.

Requires user role: ADMIN, INTEGRATOR, USER

Default value: RestoreCameraPosition

USAGE:

xConfiguration Standby WakeupAction: WakeupAction

where

WakeupAction

None: No action.

RestoreCameraPosition: When the video system leaves standby, the camera returns to the position that it had before entering standby.

DefaultCameraPosition: When the video system leaves standby, the camera moves to the factory default position.

: None/RestoreCameraPosition/DefaultCameraPosition

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: On

USAGE:

xConfiguration Standby WakeupOnMotionDetection: WakeupO nMotion Detection

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.

: Off/On

xConfiguration Standby PowerSave

You can reduce the video system's power consumption during out-of-office hours with this setting. The Power Save mode is an extension to the regular standby mode.

When the video system enters power save mode, power is cut to some of the video system's modules, for example the integrated cameras. The codec and Touch controller behaves like in regular standby. The video system wakes up from power save mode when you tap the touch panel.

Waking up the video system from power save mode takes longer than waking it up from regular standby, because the cameras must boot. You can make calls right away, but there is no outgoing video until the cameras has completed their boot process.

Requires user role: ADMIN Default value: Never

USAGE:

xConfiguration Standby PowerSave: PowerSave

where

PowerSave

: Never/OutsideOfficeHours

Never: The video system will never go into power save mode; only to regular standby.

OutsideOfficeHours: The video system will go into power save mode during out-of-

office hours. You must provide the office hours with the following settings: Time

WorkWeek FirstDayOfWeek, Time WorkWeek LastDayOfWeek, Time WorkDay Start,

and Time WorkDay End.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 TimeFormat: Ti meForm at

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: DateFo r 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 one: 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/

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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, Etc/GM T+7, Etc/G M T+ 8 , E t c / G M T+9, Etc/GM T- 0 , E t c / G M T-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.

xConfiguration Time WorkDay Start

The Time WorkWeek FirstDayOfWeek, Time WorkWeek LastDayOfWeek, Time WorkDay Start, and Time WorkDay End settings are available so that you can specify when the regular working hours are, and thereby also find the out-of-office hours.

Knowing the out-of-office hours is required if you want to use the power save mode, which is set up using the Standby PowerSave setting.

Requires user role: ADMIN, USER Default value: "07:00"

USAGE:

xConfiguration Tim e WorkDay Start: "Start"

where

Start

: String (5, 5)

The working day start time, using the 24-hour clock. Example: "07:00"

xConfiguration Time WorkDay End

Knowing the out-of-office hours is required if you want to use the power save mode, which is set up using the Standby PowerSave setting.

Requires user role: ADMIN, USER Default value: "18:00"

USAGE:

xConfiguration Tim e WorkDay End: "End"

where

End

: String (5, 5)

The working day end time, using the 24-hour clock. Example: "16:00"

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration Time WorkWeek FirstDayOfWeek

The Time WorkWeek FirstDayOfWeek, Time WorkWeek LastDayOfWeek, Time WorkDay Start,

and Time WorkDay End settings are available so that you can specify when the regular working hours are, and thereby also find the out-of-office hours.

Knowing the out-of-office hours is required if you want to use the power save mode, which is set up using the Standby PowerSave setting.

Requires user role: ADMIN, USER Default value: Monday

USAGE:

xConfiguration Tim e WorkWeek FirstDayOfWeek: FirstDayOf W e ek

where

FirstDayOf We ek

The first day of the working week. Example: Monday

: Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday

xConfiguration Time WorkWeek LastDayOfWeek

The Time WorkWeek FirstDayOfWeek, Time WorkWeek LastDayOfWeek, Time WorkDay Start,

and Time WorkDay End settings are available so that you can specify when the regular working hours are, and thereby also find the out-of-office hours.

Knowing the out-of-office hours is required if you want to use the power save mode, which is set up using the Standby PowerSave setting.

Requires user role: ADMIN, USER Default value: Friday

USAGE:

xConfiguration Tim e WorkWeek La stDayOf Week: LastDayOfWeek

where

LastDayO f Week

The last day of the working week. Example: Friday

: Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday

UserInterface configuration

xConfiguration UserInterface ContactInfo Type

Choose which type of contact information to show in the status field in the upper left corner of the display and Touch controller.

Requires user role: ADMIN Default value: Auto

USAGE:

xConfiguration UserInterface ContactInfo T y pe: Type

where

Type

: Auto/None/IPv4/IPv6/H323Id/H320Number/E164Alias/SipUri/SystemName/

DisplayName

Auto: Show the address which another system should dial to reach this video system. The address depends on the default call protocol and system registration.

None: Do not show any contact information.

IPv4: Show the system's IPv4 address.

IPv6: Show the system's IPv6 address.

H323Id: Show the system's H.323 ID (refer to the H323 H323Alias ID setting).

H320Number: Show the system's H.320 number as contact information (only applicable if connected to Cisco TelePresence ISDN Link).

E164Alias: Show the system's H.323 E164 Alias as contact information (refer to the H323 H323Alias E164 setting).

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).

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

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 Cu s to m Mess age: "Custom Message"

where

CustomMessage

Add a custom message. Add an empty string to remove a custom message.

: String (0..128)

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: On

USAGE:

xConfiguration UserInterface KeyTones M o d 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 and Touch controller.

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: "HalfwakeMessage"

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)

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



xConfiguration

API Reference Guide

xConfiguration UserInterface OSD Output

Define on which monitor the on-screen information and indicators (OSD) should be displayed.

Requires user role: ADMIN, INTEGRATOR Default value: 1

USAGE:

xConfiguration UserInterface OSD Output: Output

where

Output

: Auto/1/2/3

Auto: The system sends the on-screen information and indicators to the system's integrated display. If the system has two integrated displays, the left display is used.

Range 1-3: The system sends the on-screen information and indicators to the specified output. Choose n to send the on-screen information and indicators to the system's Output Connector n.

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 UserManagement 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: ""

USAGE:

xConfiguration UserManagement LDAP Server Add r e s s: "Add ress"

where

Address

: String (0, 255)

A valid IPv4 address, IPv6 address or hostname.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 UserManagement 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 UserManagement LDAP Encr 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 UserManagement LDAP M i ni m u m TLS Ver sion: M inimu mTLSVersio n

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 UserManagement 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

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

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 UserManagement LDAP Admin Filt er: "Filte r "

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 UserManagement 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 UserManagement LDAP Attribute: "Attribute"

where

Attribute

: String (0, 255)

The attribute name.

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco MX700, MX800 Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Introduction

About this guide

Downloading the user documentation

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

Password

Telnet

HTTP/HTTPS

RS-232 / serial connection

User roles

API output

The output modes

Using the command line

API commands

Other commands

Command line shortcuts

Searching

Value types and formats

Commands

Configurations

Status

Multiline commands

Synchronous API calls

Events

Feedback mechanism

Feedback expressions

Terminal connections

HTTP XMLAPI Authentication

HTTP XMLAPI Session Authentication

Getting status and configurations

Sending commands and configurations

Feedback from codec over HTTP

Registering for feedback

Translating from terminal mode to XML

Dos and don’ts

xConfiguration commands

Description of the xConfiguration commands

Audio configuration

xConfiguration Audio DefaultVolume

xConfiguration Audio Microphones Mute Enabled

xConfiguration Audio MicrophoneReinforcement Input Microphone [1..8] Mode

xConfiguration Audio MicrophoneReinforcement Output Line [1..4] Mode

xConfiguration Audio MicrophoneReinforcement Gain

xConfiguration Audio SoundsAndAlerts RingTone

xConfiguration Audio SoundsAndAlerts RingVolume

xConfiguration Audio Input HDMI [n] Level

xConfiguration Audio Input HDMI [n] Mode

xConfiguration Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] Equalizer ID

xConfiguration Audio Input Line [1..4] Equalizer Mode

xConfiguration Audio Input Line [1..4] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Line [1..4] VideoAssociation VideoInputSource

xConfiguration Audio Input Line [1..4] Channel

xConfiguration Audio Input Line [1..4] Level

xConfiguration Audio Input Line [1..4] Mode

xConfiguration Audio Input Microphone [1..8] EchoControl Mode

xConfiguration Audio Input Microphone [1..8] EchoControl NoiseReduction

xConfiguration Audio Input Microphone [1..8] EchoControl Dereverberation

xConfiguration Audio Input Microphone [1..8] Equalizer ID

xConfiguration Audio Input Microphone [1..8] Equalizer Mode

xConfiguration Audio Input Microphone [1..8] VideoAssociation MuteOnInactiveVideo

xConfiguration Audio Input Microphone [1..8] VideoAssociation VideoInputSource

xConfiguration Audio Input Microphone [1..8] Level

xConfiguration Audio Input Microphone [1..8] Mode

xConfiguration Audio Input Microphone [1..8] Type

xConfiguration Audio Output Line [1..6] Channel

xConfiguration Audio Output Line [1..6] Delay DelayMs

xConfiguration Audio Output Line [1..6] Delay Mode

xConfiguration Audio Output Line [1..6] Equalizer ID

xConfiguration Audio Output Line [1..6] Equalizer Mode

xConfiguration Audio Output Line [1..6] Level

xConfiguration Audio Output Line [1..6] Mode