Xacli - Status Type Commands; Understanding Status Information Structuring - TANDBERG Codec 3000 MXP Reference Manual

About the TANDBERG API
XACLI – Status Type Commands
About Status Type Commands
All Status information is organized in a
hierarchic tree structure.
To get an overview of accessible top-
level status elements within a status-
? help
type command, type or after the
status-type commands (xstatus/xhis-
tory/xevent).
Understanding Status
Information Structuring
All Status information is organized in a
hierarchic tree structure, very much like
files and folders on a computer. The
tree structure consists of container-
elements (folders) and value elements
(files). Container-elements contains
sub-elements, while value elements
contain values. All elements have an
element name and an element item
number. There can exist multiple
instances of an element.
An element can also have various
attributes. Attributes are used to add
meta information to an element. The
sub-structure of a container-element may
vary depending on the attribute values.
The relationship between attribute values
of a given element and its underlying sub-
structure can be read from the sections
documenting the various status elements.
E.g. a call that is disconnected does not
contain any data (except a disconnect
cause value), while an active call contains
information about bandwidths, protocols,
channels etc.
D 13887.08
MAY 2008
EXAMPLE
Defining Element names, Values, Attributes, and Item No.:
xstatus call 1
*s Call 1 (status=Synced, type=Vtlph, protocol=H323, direction=Outgoing,
CallRate:
768
RemoteNumber:
"558458"
Mute:
Off
Microphone:
Off
Duration:
20
MuteOutgoing:
Off
Channels 1 (type=Incoming):
.
. (some lines have been removed for clarity)
.
Video 2 (status=Inactive):
Data (status=Inactive):
*s/end
OK
In the above example. Element names are shown in
EXAMPLE
xstatus ?
- Status -
Audio ExternalNetwork
BRI [1..6] FarEndInformation
Call [1..11] Feedback [1..3]
Camera [1..13] G703
CameraTracking H323Gatekeeper
Conference IP
Ethernet NTP
ExternalManager PRI
OK
/
/
orange. Values are shown in green.
RemoteSwUpgrade
Screensaver
SIP
SoftwareUpgrade
SystemUnit
VirtualMonitor [1..4]
Warning [1..10]
51
TANDBERG 3000
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
logTag=1):
Attributes are shown in magenta. Item No. is shown in
EXAMPLE
xhistory ?
- History -
Call [1..20]
OK
xevent ?
- Event -
AuthenticationFailure MessageBoxResult
CallDisconnected PacketlossDownSpeed
CallStatisticsIP [1..11] SString
CallSuccessful SystemActivity
DownspeedingFinished
OK
MXP & 6000 MXP
cyan