Xacli – status type commands, Understanding status information structuring – TANDBERG 6000MXP User Manual

Page 51

Advertising
background image

51

D 13887.08
MAY 2008

TANDBERG 3000

MXP

&

6000

MXP

REFERENCE GUIDE FOR SYSTEM INTEGRATORS

EXAMPLE

xhistory ?

- History -

Call [1..20]

OK
xevent ?
- Event -
AuthenticationFailure MessageBoxResult

CallDisconnected PacketlossDownSpeed

CallStatisticsIP [1..11] SString

CallSuccessful SystemActivity

DownspeedingFinished
OK

All Status information is organized in a
hierarchic tree structure.
To get an overview of accessible top-
level status elements within a status-
type command, type

?

or

help

after the

status-type commands (xstatus/xhis-
tory/xevent).

EXAMPLE

Defining Element names, Values, Attributes, and Item No.:
xstatus call 1

*s

Call

1

(

status=Synced, type=Vtlph, protocol=H323, direction=Outgoing, logTag=1

):

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

orange.

Values are shown in

green.

Attributes are shown in

magenta.

Item No. is shown in

cyan

XACLI – Status Type Commands

About the TANDBERG API

About Status Type Commands

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.

Understanding Status

Information Structuring

EXAMPLE

xstatus ?
- Status -

Audio ExternalNetwork RemoteSwUpgrade

BRI [1..6] FarEndInformation Screensaver

Call [1..11] Feedback [1..3] SIP

Camera [1..13] G703 SoftwareUpgrade

CameraTracking H323Gatekeeper SystemUnit

Conference IP VirtualMonitor [1..4]

Ethernet NTP Warning [1..10]

ExternalManager PRI

OK

Advertising
This manual is related to the following products: