Cisco TelePresence ISDN Link User manual

1
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Software version IL1.0
JUNE 2012
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence ISDN Link
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus

2
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
TA - ToC -
Hidden text
anchor
Table of Contents
Introduction
About this guide .................................................................. 4
User documentation ........................................................ 4
Software .......................................................................... 4
Cisco contacts................................................................. 4
About the API
About the API ...................................................................... 6
The API-Engine ............................................................... 6
Structuring of Information................................................ 6
Addressing Using XPath or SimplePath .......................... 7
Feedback......................................................................... 7
Connecting to the ISDN Link ............................................... 8
Accessing XACLI............................................................. 8
COM Port settings........................................................... 8
SSH login ..................................................................... 8
Serial port login............................................................ 8
Hardware & Cabling (RS-232) ......................................... 8
Troubleshooting (RS-232) ............................................... 8
Value types and formats ..................................................... 9
User commands................................................................ 10
Main type of commands.....................................................11
Conguration type commands.......................................11
Command type commands............................................11
Status type commands ..................................................11
Special commands.........................................................11
Feedback type command...........................................11
Preferences type command .......................................11
About xConguration .........................................................12
About xCommand ..............................................................13
About xStatus commands..................................................14
About xFeedback .............................................................. 15
About xPreferences .......................................................... 16
The SystemTools commands .............................................17
What’s in
this guide? Description of the xConguration commands
Description of the xConguration commands .................. 20
Description of the xCommand commands
Description of the xCommands commands...................... 38
Description of the xStatus commands
Description of the xStatus commands .............................. 42
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/isdnlink-docs
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
Contents

3
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Chapter 1
Introduction
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
Introduction

4
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
About this guide
This guide will introduce you to the Application Programmer
Interface (API) and serve as a reference guide for the
command line commands for Cisco TelePresence ISDN Link.
User documentation
The user documentation for the Cisco TelePresence ISDN Link,
running the IL software, have several guides.
• Installation guide
• Software release notes
• Administrator guide
• API reference guide
• Regulatory compliance and safety information
• License information
Download the user documentation
Go to: http://www.cisco.com/go/isdnlink-docs
Software
You can download the software for your product from the
Cisco web site.
Go to: http://www.cisco.com/cisco/software/navigator.html
Cisco contacts
On our web site you will nd an overview of the worldwide
Cisco contacts.
Go to: http://www.cisco.com/web/siteassets/contacts
Corporate Headquarters
Cisco Systems, Inc.
170 West Tasman Dr.
San Jose, CA 95134 USA
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
Introduction

5
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Chapter 2
About the API
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API

6
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
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 dierent
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 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.
API-Engine
RS-232
cable
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 reect 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: xConguration.
Typical examples include: set or read the
value of the H320 network type, ISDN PRI
switch type, call rate, etc. All conguration
information is structured in a hierarchy making
up a database of system settings.
XACLI
(XML)
SSH
via LAN
Consequently, the exchange of information
can be divided into:
1. Information owing 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 owing to target. This we call
WRITE information (W).
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API

7
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Addressing Using XPath or SimplePath
To address information in the hierarchic structure of Status and
Conguration information, the systems support abbreviated
XML Path Language (XPath) and a proprietary notation called
SimplePath (only available using XACLI).
This allows the user to address everything from a single
element of data (for example the call rate of a specic call)
to larger parts of the hierarchy (for example all information
available for a given call).
Using XPath
Addressing the 1st DNS Server Address of the 1st Network:
Each level is separated with a slash (‘/’). Item numbers are
added in brackets after the element name:
• Network[1]/DNS Server[1]/Address
Example:
xConguration Network[1]/DNS Server[1]/Address
*c xConguration Network 1 DNS Server 1 Address:
“test”
OK
Using SimplePath
Addressing the 1st DNS Server Address of the 1st Network:
Both levels and item numbers are separated with white spaces:
• Network 1 DNS Server 1 Address
Example:
xConguration Network 1 DNS Server 1 Address
*c xConguration Network 1 DNS Server 1 Address:
“test”
OK
Feedback
Feedback is an extremely powerful feature where the system
actively returns updated status and conguration information to
the user whenever changes occur.
The user can specify what parts of the status and conguration
hierarchies it wants to monitor by using XPath. The user can
thereby limit the amount of information it receives from the
target system to only those parts being of interest for the
given application. This will also reduce the load on the link
connecting the systems.
Feedback is supported on XACLI (RS-232/SSH).
The system uses SimplePath when presenting congurations.
The structuring of information together with XPath and
SimplePath for addressing, makes up powerful features as
the ability to search and setting of multiple instances of a
conguration.
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API

8
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Connecting to the ISDN Link
Accessing XACLI
XACLI can be accessed through SSH via the LAN interface or
through the COM port by connecting a serial cable to the serial
interface connector, referred to as the COM port.
The COM port (RS-232) is a 9-pin, female, D-sub connector
located on the back of the unit. The connector is marked with
the text: COM.
COM Port settings
Use: 115200 bps, 8 data bits, 1 stop bit, no parity.
SSH login
• User name is: admin
• The default password is blank.
Serial port login
• User name is: admin
• The default password is blank.
Hardware & Cabling (RS-232)
The pin outs for the RS-232 are dened in the tables to the
right. Observe that the DTE (Data Terminal Equipment), could
be a PC or any other device capable of serial communication.
Cable. A straight-through cable should be used between
the RS-232 port and the DTE. The lower table shows the
recommended cable-wiring scheme when connecting the
ISDN Link to a PC through RS-232.
DTR and RTS are ignored. DSR, CD, and CTS are always
asserted, while RI is not used.
Troubleshooting (RS-232)
If communication cannot be established between the PC/
terminal and the unit, the following should be checked:
1. Verify that the serial cable is a straight-through 9-pin to
9-pin cable.
2. Conrm that the conguration of the PC/terminal’s serial
RS-232 port is identical to the conguration of the RS-232
port.
3. Verify that the PC/terminal’s serial RS-232 port is working
properly by connecting it back-to-back to another PC/
terminal (using a special crossover cable for that purpose)
and send characters in both directions.
COMport(RS-232)
Pin Signal name Direction
1 Carrier detect, CD From DCE
2 Receive data, RXD From DCE
3Transmit data, TXD To DCE
4Data terminal ready, DTR From DCE
5Signal GND
6 Data set ready, DSR From DCE
7 Ready to send, RTS To DCE
8 Clear to send, CTS From DCE
9 Ring indicator, RI From DCE
Cablewiring(RS-232)DCE<->PC
DCE 9 pin Direction PC DTE, 9 pin
1 CD —> 1 CD
2 RD —> 2 RD
3 TD <— 3 TD
4 DTR <— 4 DTR
5 GND <—> 5 GND
6 DSR —> 6 DSR
7 RTS <— 7 RTS
8 CTS —> 8 CTS
9 RI —> 9 RI
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API

9
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
Value types and formats
The system supports the following value types:
• Integer values
• Literal values
• String values
Strings can have rules that further specify their format and
length. Integer input may have a limited valid range.
Formatsforvaluetypes
Integer values:<x..y>
Denes the valid range for an integer input. x = min value, y = max value.
<1..100>
Literal values: <X/Y/../Z>
Denes the possible values for a given conguration.
<On/O/Auto>
String values: <S: x, y>
Denes that the valid input for this conguration is a String with minimum length x and maximum length of y
characters.
<S: 0, 49>
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API

10
Cisco TelePresence ISDN Link API Reference Guide
D14953.01 ISDN Link API Reference Guide IL1.0 June 2012.
© 2012 Cisco Systems, Inc. All rights reserved. www.cisco.com
?
- User Commands -
help xcommand xconguration xfeedback xgetxml
xpreferences xstatus bye echo log
systemtools
OK
User commands
By typing ?or help after connecting to the unit, the system will
list all supported root commands.
Bye
The bye command will close the command line interface.
Echo <on/o>
If echo is set to On the key inputs are displayed when entering
text in a command line interface.
If echo is set to O no user input is displayed when entering
text in a command line interface.
The oher commands
The other user commands are described in the following
pages.
Contents
Contact us
Introduction
About the API
xConguration
xCommand
xStatus
About the API