3 messages supported by multiple product types, 1 device.query, 2 device.network.query – TANDBERG 3.0 User Manual
Page 12: Messages supported by multiple product types, 8 3.2 device.network.query
Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
8
3 Messages supported by multiple product types
The methods in this section are common to many devices, including video conferencing servers, IP VCR
products, ISDN GW products, and IP GW products. Not all methods are supported by all product types, and
not all fields will be present in responses from all products.
3.1 device.query
There are no parameters passed with this method call. The method response returns the following:
Parameter
Type
Comments
currentTime dateTime.iso8601
The
system’s current time (UTC).
restartTime
dateTime.iso8601
The date and time at which the system was last
restarted.
serial
String
The serial number of the device.
softwareVersion
String
The software version of the running software.
buildVersion
String
The build version of the running software.
model
String
The model of this device, e.g. "Codian MCU 4210".
apiVersion
String
The version number of the API implemented by this
device.
activatedFeatures
array of structs
Currently, only contains a string "feature" with a
short description of the feature.
totalVideoPorts
Integer
The total number of video ports on the device. Only
present on MCU and VCR products.
totalAudioOnlyPorts Integer
The total number of additional audio-only ports on
the device. Only present on MCU and VCR products.
portReservationMode String
enabled
or
disabled
, depending on the Media Port
Reservation configuration setting. Only present on
MCU products.
maxVideoResolution String
One
of
cif
or
4cif
. Only present on MCU and VCR
products.
isdnPorts Integer The
number
of ISDN ports. Only present on ISDN
gateways.
3.2 device.network.query
This call takes no parameters. The response returns the following:
Parameter
Type
Comments
portA
struct (see below)
Contains the configuration and status for port A.
portB
struct (see below)
Contains the configuration and status for port B.
The format for the two structures above is:
Field
Type
Comments
enabled
Boolean
true if the port is enabled, otherwise false.
hostName (optional)
String
The host name of this port.
dhcp (optional)
Boolean
true if configured by DHCP, otherwise false.
ipAddress (optional)
String
a.b.c.d format.
subnetMask (optional)
String
a.b.c.d format.
defaultGateway (optional) String a.b.c.d
format.