You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Matrix Query 0x0097

Matrix Query 0x0097

SwitchKit Name

DeviceServerQuery

Type

EXS API and SwitchKit API message

Description

Matrix Query 0x0097

This message is sent by the Host to query details of set configuration data and the status of the IP Signaling Series 3 card interface.

NOTE: This message supports a feature of a Dialogic product other than SwitchKit. For that reason, the message is not to be used in a SwitchKit only environment.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE QueryType;

UBYTE Reserved;

} XL_DeviceServerQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE TLVCount;

UBYTE Data[250];

} XL_DeviceServerQueryAck;

C++ Class

class XLC_DeviceServerConfig : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getConfigType() const;

void setConfigType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_DeviceServerQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE | RESPONSE
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0xNNNN) | 1, 2 | Length (0xNNNN)
3, 4 | Message Type (0x0097) | 3, 4 | Message Type (0x0097)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Sequence Number (same as message)
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB
10 | Number of TLVs to follow
Number of AEs to follow
AEs 0x00 00 Null 0x73 IP Signaling Series 3 Card ID
: | Query Type 0x01 Query List of IP Signaling Series 3 Cards Configured (NOTE: AIB is Null AIB) 0x02 Query IP Signaling Series 3 Card Basic Information This returns for the IP Signaling Series 3 Card: Card Type Card Version Card Operational State Card Redundancy Status Card Configuration Tag Card General Data 0x03 Query IP Signaling Series 3 Card General Information 0x04 Query Gateways on this IP Signaling Card Series 3 | 11 | TLV 0x0001 Add IP Signaling Series 3 Card 0x0005 IP Signaling Series 3 Card IP Address 0x0004 Configuration Tag 0x0007 IP Signaling Series 3 Card Service State 0x000B V5 Cpath Assignment 0x000F IP Signaling Series 3 Card Interface Support
: | Reserved (0x00) | : | Response 0x0010 Positive Ack Everything validated and the action was initiated 0x1200 Invalid IP Signaling Series 3 Card ID Invalid span was passed from the host 0x1201 Invalid Query Type Invalid value for the Query Type field was passed 0x120C IP Signaling Series 3 cards are not configured
: | Checksum | : | Checksum

A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Most Significant Bit
Least Significant Bit
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.