TANDBERG D13639 manual Accessing Xacli, Root commands, Addressing

Page 20

TANDBERG MPS API

User Guide

2.1 XACLI

2.1.1 Accessing XACLI

XACLI can be accessed through Telnet via the LAN interface or through RS-232 by connecting a serial cable to the serial interface connector, referred to as the Dataport.

48 Telnet sessions can be active at the same time in addition to the RS-232 connection.

2.1.2 Root commands

For each of the XML documents supported by the system, there is a corresponding XACLI root command. The root command has the same name as the corresponding XML document, except that the root command is prefixed by an “x”:

XML document

XACLI root command

status.xml

xstatus

history.xml

xhistory

configuration.xml

xconfiguration

directory.xml

xdirectory

command.xml

xcommand

The information in the TANDBERG XML engine is divided into three main types: Status Information, Configuration Information and Command Information, ref. the documentation of the

TANDBERG XML API.

As there is a fundamental difference in these three main types of information, there is also three different ways of working with the information using XACLI.

2.1.3 Addressing

XACLI supports XPath for addressing Status Information and Configuration Information. In addition there is support for the proprietary TANDBERG SimplePath notation. With SimplePath notation an element or a group of elements are addressed by supplying a space separated list of element names (elemName) and optional element instance numbers (item):

<elemName> [item] <elemName> [item] ...

If the instance number of a given element is omitted, the expression addresses all instances of this element

Example 2.1

To address the BaudRate sub-element of SerialPort 2:

XPath: SerialPort[2]/BaudRate

SimplePath: SerialPort 2 BaudRate

To address the BaudRate sub-element of all SerialPort elements:

XPath: SerialPort/BaudRate

SimplePath: SerialPort BaudRate

18

Image 20
Contents Tandberg MPS API User GuideTable of Contents Tandberg API DisclaimerIntroduction to XML ExampleExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Addressing using XPath Tandberg XML EngineStructuring of Information FeedbackTandberg MPS API Status Documents r XML DocumentsDocuments Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Introduction to Tandberg XML API Service Txas Bare-bone Https accessGetxml FormputxmlExercises ExerciseTandberg MPS API XML-based Advanced Command Line Interface Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Status-type root commands Xstatus / xhistory FormatXstatus ? Xstatus call 1 remotenumberXML Xacli *s IPConfiguration-type root commands xconfiguration/xdirectory Configuration helpXconfiguration ? Xdirectory ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write Xconfiguration ip/assignment static Command-type root commands xcommand Command helpXcommand ? Xcommand ??Issuing a command Example 2.12 xcommand Dial ?Xcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 XML Output xgetxml Xgetxml status/ipSpecial Commands XfeedbackXfeedback ? Xfeedback register status/call/channels/audio/protocolXfeedback register status/call Xcom dial Xfeedback register status/call@status=Disconnected Xcom dialXcom disc Xfeedback register status/call@status=Synced Xcom dialXpreferences Xpreferences ?Xstat call 1 channels 1 audio Xpreferences detaillevel Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API H323Gatekeeper 1..2 Authentication Password S 0 Http Mode On/OffTandberg MPS API LoS Polarity Positive/Negative LoS Retry MCURTP SerialInterfaceCard SessionSIP Mode On/Off SIP Interface Authentication UserName S 0SIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDPTandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry CallMuteVideo ConferenceDisconnect ConferenceModify Parameters Conferencer OK Result parametersConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall OK Result parameters Error Result parameters FeedbackDeregister FeedbackRegisterFloorToSite FloorToSiteEnd GroupEntryAdd Parameters Name S 0, 48 The entry’s nameGroupEntryDelete LayoutLock LayoutUnLock NetworkId NetworkModule OK Result parameters Windowr CallIDr 1..176 Call Error Result parametersLocalEntryAdd LocalEntryDelete Command used to add option key ProtectNumberRemove VideoTextSet API Status Status.xml xstatus ExamplesTandberg MPS API Examples Tandberg MPS API Mcuid Ethernet Top level attributes Feedback Top level attributesUser Guide EndNone MediaBoard 1..8 Top level attributesSystemUnit Top level attributes None Summary SerialInterfaceCard ISDNInterfaceCard Top level attributes Status on/off SummaryTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end History.xml xhistory Conference Top level attributesEvent.xml xevent Audio TotalPacketsPacketLoss PacketsDroppedEnd