Cisco TelePresence ISDN Link Reference Manual page 6

Cisco TelePresence ISDN Link
Contents Introduction
About the API
The API-engine can be accessed by an easy-
to-use Command Line Interface called XACLI
using RS-232 or SSH.
The information is stored in a hierarchic tree
structure which is accessible from different
interfaces.
•
When accessing the API-engine using
XACLI (RS-232 or SSH), the information is
formatted in a proprietary Command Line
style or in XML formatting.
The API-Engine
The API-Engine is optimized for easy, yet
advanced, machine-machine interaction
between a Cisco system and an external
control application.
The main features can be summarized to:
1. Structuring of information
2. Addressing using XPath (XML Path
Language) or SimplePath
3. Feedback
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved.
About the API About the API
XACLI
(XML)
SSH
via LAN
Structuring of Information
An application programming interface (API)
can be seen as a gate where information is
exchanged between two systems – a control
application and a target system.
The control application transmits instructions
to the target system, while the target system
supplies information about how these
instructions are executed, in addition to other
system related information.
xConfiguration xCommand
RS-232
cable
API-Engine
Consequently, the exchange of information
can be divided into:
1. Information flowing from target. This
we call READ information (R). The (R)
should not be confused with the (r)
used to indicate required parameters for
xCommand.
2. Information flowing to target. This we call
WRITE information (W).
6
API Reference Guide
xStatus Contact us
Main types of information
•
READ information (R)
•
WRITE information (W)
•
READ/WRITE information (RW)
(R) READ information: xStatus.
Typical examples include: read the network
status, ISDN status etc. All status information
is structured in a hierarchy, making up a
database constantly being updated by the
system to reflect process changes.
(W) WRITE information: xCommand.
Typical examples include: set date and time,
get date and time, software upgrade, etc.
A command is usually followed by a set of
parameters to specify how the given action is
to be executed.
(RW) READ/WRITE information: xConfiguration.
Typical examples include: set or read the
value of the H320 network type, ISDN PRI
switch type, call rate, etc. All configuration
information is structured in a hierarchy making
up a database of system settings.
www.cisco.com