You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > System Configuration Query 0x00B4

System Configuration Query 0x00B4

SwitchKit Name

SystemConfigQuery

Type

EXS API and SwitchKit API message

Description

System Configuration Query 0x00B4

Use this message to query various configuration settings in the CSP. Some query results are reported in the response to the message, while others generate a Generic Report message.

NOTE: The acknowledgment for Active Conference IDs (query type 0x04) will return partial data — only the number of conferences. The report will have the remaining data, that is, all the conference IDs.

The data for the following Query Types is returned in the response:

• 0x02 - Message Resend Logic

• 0x03 - Host Link Failure Detection Logic

• 0x04 - Active Conference IDs

• 0x06 - System Busy Warning

• 0x17 - Extended Conference Enable

 

The data for the following Query Types is returned in the Generic Report message:

• 0x04 - Active Conference IDs

• 0x05 - Channel State

• 0x07 - Resource Threshold

• 0x09 - Resource Usage Reporting

• 0x0B - Approaching Busy Threshold for Slots

• 0x0C - Real Busy Threshold for Slots

• 0x10 - Detailed Conference Information

• 0x11 - DSP Resource Threshold

• 0x13 - Conference Speakers

• 0x14 - Conferencing Features

• 0x15 - Child Conference Information

• 0x16 - Child Conference IDs

• 0x18 - Cache File Query

For SwitchKit

To get this report, you must register for it by calling the sk_msgRegister function with the parameter, SK_RESOURCE_UTIL_REPORT.

Sent by

Host Application

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE QueryType;

UBYTE Data;

UBYTE reserved49[221];

} XL_SystemConfigQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE Data[251];

} XL_SystemConfigQueryAck;

C++ Class

NOTE: The functions, getDataBlock() and setDataBlock(), should be used only for QueryType 0x18. The setData() function should not be used for this QueryType.

 

class XLC_SystemConfigQuery : public XLC_OutboundMessage

{

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getStartSpan() const;

void setStartSpan(XBYTE x);

UBYTE getStartChannel() const;

void setStartChannel(UBYTE x);

XBYTE getEndSpan() const;

void setEndSpan(XBYTE x);

UBYTE getEndChannel() const;

void setEndChannel(UBYTE x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x)

UBYTE getQueryType() const;

void setQueryType(UBYTE x);

UBYTE *getData() const ;

void setData(UBYTE *x) ;

const UBYTE *getDataBlock() const;

UBYTE *getDataBlock();

void setDataBlock(UBYTE *x);

};

C++ Class Response

class XLC_SystemConfigQueryAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0xNNNN)

1, 2

Length (0xNNNN)

3, 4

Message Type (0x00B4)

3, 4

Message Type (0x00B4)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

Status MSB, LSB

8

AIB

0x00 - Individual AEs

0x01 - Range

 

Depending on Query Type

 

Data

The values in the Response’s Data fields depend on the value of the Query Type field.

 

There is no response data for the following Query Types. The data for these queries is returned in the Generic Report message.

0x05 - Channel State

0x07 - Resource Threshold

0x09 - Resource Usage Reporting

0x0B - Approaching Busy Threshold for Slots

0x0C - Real Busy Threshold for Slots

0x10 - Detailed Conference Information

0x13 - Conference Speakers

0x14 - Conferencing Features

0x15 - Child Conference Information

0x16 - Child Conference IDs (data also returned in this
message)

0x17 - Extended Conference Enable

0x18 - Cache File Query

9

Number of AEs to follow

10

AEs

The Address Element used depends on the Query Type, as follows:

0x02 Message Resend Logic

0x00 00 00 00 Null

0x03 Host Link Failure Detection Logic

0x00 00 00 00 Null

0x04 Active Conference IDs

0x00 00 00 00 Null

0x05 Channel State

0x0D Channel (A)

0x0D Channel (B)

(For one channel enter same channel in

both AEs).

0x06 System Busy Warning

0x00 00 00 00 Null

0x07 Resource Threshold

0x00 00 00 00 Null

 

0x02 Message Resend Logic

Data[0] Resend once

0x00 Disabled

0x01 Enabled

0x02 Enable and Generate Alarm message

Data[1] Resend Until Acknowledged

0x03 Resend Alarm, Alarm Cleared, Request for Service, Request for Service with Data, and Channel Release until acknowledged by the host.

0x04 Do not resend messages in option 0x03 until acknowledged by the host (this option cancels option 0x03)

0x09 Resource Usage Reporting

0x00 00 00 00 Null

0x0B Approaching Busy Threshold for Slots

0x01 Slot

0x0C Real Busy Threshold for Slots

0x01 Slot

0x10 Detailed Conference Information

0x55 Conference ID

0x11 DSP Resource Threshold

0x01 Slot

0x13 Conference Speakers

0x55 Conference ID

0x14 Conferencing Features

0x0D Channel (2 AEs with same Channel)

0x55 Conference ID or

0x45 Child Conference ID

0x15 Child Conference Information

0x45 Child Conference ID

0x16 Child Conference IDs

0x55 Conference ID (Parent)

0x18 Cache File Query

0x01 Slot

:

:

Query Type

0x00 Reserved

0x01 Reserved

0x02 Message Resend Logic

0x03 Host Link Failure Detection Logic

0x04 Active Conference IDs

0x05 Channel State

0x06 System Busy Warning

0x07 Resource Threshold

0x09 Resource Usage Reporting

0x0B Approaching Busy Threshold for Slots

0x0C Real Busy Threshold for Slots

0x10 Detailed Conference Information

0x11 DSP Resource Threshold

0x13 Conference Speakers

0x14 Conferencing Features

0x15 Child Conference Information

0x16 Child Conference IDs

0x17 Extended Conference Enable

0x18 Cache File Query

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

0x03 Host Link Failure Detection Logic

Data[0] Feature Enabled/Disabled

0x00 Disable

0x01 Enable

Data[1] Response to Host Link Failure

Bit 0 Setting of spans and channels

0 All channels out of service when host link

failure detected (Default) *

1 All spans and channels out of service when

host link failure detected

Bit 1 Setting of response

0 A response is sent

1 No response is not sent

Bit 2 Setting of SCCP/TCAP OOS

0 SCCP/TCAP is not taken out-of-service

1 SCCP/TCAP is taken out-of-service

Data[2, 3] Failure Detection Timer

10 ms units (cannot be less than 30,000 ms.)

 

 

0x11 - DSP Resource Threshold

 

Data[1] 0-100 Percentage of resources to exceed to produce alarm (default =100).

Data[2] 0-100 Percentage of resources to go below to clear alarm (default =0).

 

 

Data

Resource Threshold (0x07)

Resource Type

 

DSP Resource Threshold (0x011)

Function Type

 

Tone Reception

0x01 DTMF ΅-law (all DSP cards)

0x02 MFR1 ΅-law (all DSP cards)

0x03 DTMF A-Law (all DSP cards)

0x04 MFR1 A-Law (all DSP cards)

0x05 MFR2 A-Law (all DSP cards)

0x06 MFR2 ΅-Law (all DSP cards)

0x07 CPA A-Law (all DSP cards)

0x08 CPA ΅-Law (all DSP cards)

0x09 E1 Dial Pulse (MFDSP and DSP-ONE cards only)

0x0A Energy Detection (all DSP cards)

0x0C DTMF High Pass Filter ΅-Law (MFDSP card only)

0x0D DTMF High Pass Filter A-Law (MFDSP card only)

0x0E Coin Detection ΅-Law (DSP-ONE card only)

0x0F Coin Detection A-Law (DSP-ONE card only)

 

Tone Generation

0x10 DTMF mu-law

0x11 DTMF A-law

0x12 MFR1 mu-law

0x13 MFR1 A-law

0x14 CPT4 mu-law

0x15 CPT4 A-law

0x16 MFR2 Forward A-law

0x17 MFR2 Forward mu-law

0x18 MFR2 Backward A-law

0x19 MFR2 Backward mu-law

0x1A Bong Tone mu-law

0x1B Bong Tone A-law

0x30 Universal Tone Generation mu-law

0x31 Universal Tone Generation A-law

 

Conferencing

0x1E Standard ΅-Law (MFDSP and DSP-ONE cards only)

0x1F Standard A-Law (MFDSP and DSP-ONE cards only)

0x20 Mixed (MFDSP and DSP-ONE cards only)

0x21 Monitor (all DSP cards)

0x22 Unified (DSP-ONE and DSP 2 cards only)

0x23 DTMF-Clamped Conference (DSP-ONE and DSP 2 cards only)

Announcement Generation

0x1C VRAS (MFDSP and DSP-ONE cards only)

 

File Playback / Record

0x1D File Playback / Record (DSP 2 card only)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Cache File Query (0x018)

[0-3] File ID (applies only if Query Type is Cache File Query (0x18)

 

For all other Query Types, the Data field does not apply.