TANDBERG 6000MXP - Manual (Page 44)

44 D 13887.08
MAY 2008
TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
XACLI – Main Types of Commands
About the TANDBERG API
About Main Types of Commands
The XACLI is divided into three main types
of commands (and a fourth – see below),
reflecting the information types supported
by the
TANDBERG API Engine .
The main types are:
Configuration-type commands •
Status-type commands •
Command-type commands •
In addition to the above sets of commands,
XACLI supports the following set of special
commands: xfeedback is a command used to specify
what parts of the configuration and status
hierarchies to monitor. Feedback will only
be issued on the RS 232/Telnet for which it
is specified. If connecting to the TANDBERG
MXP with multiple RS 232/Telnet sessions,
each session can define feedback individu-
ally.
More on this can be found in
xfeedback .
xpreferences is used to set various prefer-
ences for the RS 232/Telnet sessions. Each
session can define preferences individually.
IMPORTANT! This command has various
settings to define the formatting of the XACLI
output. It is therefore important to define set-
tings to match the parser used on the control
system. XACLI is designed to make parsing of
data from the TANDBERG
MXP very simple.
More on this can be found in xpreferences .
xgetxml gives access to the exact same
information as the Main types of commands
(xstatus, xhistory, xconfiguration etc.), but
returns the information XML formatted.
More on this can be found in
xgetxml .
Commands returning information about
the system and system processes, i.e.
information generated by the system. E.g.
status about ongoing calls, network status,
conference status etc. All status informa-
tion is structured in a hierarchy, making up
a database constantly being updated by
the system to reflect system and process
changes.
Supported Status-type commands:
xStatu • s
xHistor • y
xEven • t
Commands defining system settings.
Configuration-type commands are either
supplied or read by the user. E.g. default
callrate, baudrate of a serial port, ena-
bling/disabling of various features etc.
All Configurations are structured in a
hierarchy making up a database of system
settings.
Supported Configuration-type commands:
xConfiguratio • n
xDirector • y
Commands instructing the system to per-
form an action. E.g. instructing the system
to place a call, assigning floor to a specific
site, disconnecting a call etc. A command
is usually followed by a set of parameters
to specify how the given action is to be
executed.
Supported Command-type commands:
xComman • d
Status Type Commands Configuration Type Commands Command Type Commands
Special Commands