Xcommand Httpfeedback Register; Peripherals Commands; Xcommand Peripherals Connect - Cisco TelePresence SX20 Codec Reference Manual

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

Advertisement

Cisco TelePresence SX20 Codec
Introduction

xCommand HttpFeedback Register

Register the system to a HTTP(S) server to return XML feedback over HTTP(S) to specific URLs.
Requires user role: ADMIN
USAGE:
xCommand HttpFeedback Register FeedbackSlot:
ServerUrl: "ServerUrl" [Expression: "Expression"]
where
: Integer (1..4)
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 feedbackslot to register its
expressions.
: XML/JSON
Format
Set the format for the feedback from the HTTP server to XML or JSON.
: String (1, 2048)
ServerUrl
The URL to the HTTP server where you want the codec to post the HTTP feedback
messages to.
: String (1, 255)
Expression
The XPath expression specifies which parts of the Status, Configuration or Event XML
documents are monitored. You can have from 0 to 15 XPath expressions in the same
command.
SX20 Codec API Reference Guide CE9.1, JUNE 2017.
D15316.07
About the API
xConfiguration
FeedbackSlot
[Format: Format]
xCommand
xCommand

Peripherals commands

xCommand Peripherals Connect

Register peripherals that are connected to the codec, such as control systems and touch
panels. The registered peripherals are displayed on the web interface under Configuration >
Peripherals.
This command should be used when the peripheral connects to the codec for the first time
or when the software version on the peripheral has changed. The list of connected devices is
available with the command xStatus Peripherals ConnectedDevice [n] Status.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand Peripherals Connect [HardwareInfo: "HardwareInfo"] ID: "ID" [Name:
"Name"] [NetworkAddress: "NetworkAddress"] [SerialNumber: "SerialNumber"]
[SoftwareInfo: "SoftwareInfo"] Type:
where
: String (0, 100)
HardwareInfo
The device's hardware number.
: String (1, 100)
ID
A unique ID for the device you are connecting to, typically a MAC address.
: String (0, 100)
Name
Define a name for the device.
: String (0, 100)
NetworkAddress
Network address for the device you are connecting to.
: String (0, 100)
SerialNumber
The device's serial number.
: String (0, 100)
SoftwareInfo
Software version the device is running.
: Byod/ControlSystem/Other/TouchPanel
Type
Define the type of device you are connecting to.
108
API Reference Guide
xStatus
Appendices
Type
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Advertisement

Table of Contents
loading

Table of Contents