V5 Configuration Query 0x007C

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

SwitchKit Name

V5Query

Type

EXS API and SwitchKit API message

Description

This message queries the configured values of all configurable V5.2 parameters.

Sent by

Host

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE QueryType;

UBYTE Reserved;

} XL_V5Query;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE TLVCount;

UBYTE Data[250];

} XL_V5QueryAck;

C++ Class

class XLC_V5Query : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

XBYTE getV5ID() const;

void setV5ID(XBYTE x);

UBYTE getQueryType() const;

void setQueryType(UBYTE x);

UBYTE getReserved() const;

void setReserved(UBYTE x);

};

C++ Class Response

class XLC_V5QueryAck : 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 (0x007C)	3, 4	Message Type (0x007C)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Sequence Number (same as message)
7	Logical Node ID	7	Logical Node ID
8 :	AIB Address Method	8, 9	Status (MSB, LSB) 0x01 Unrecognized Entity 0x02 Invalid C Channel 0x03 Unable to delete TLV from IMSG 0x04 Unrecognized TLV tag 0x05 Incorrect AIB 0x06 Unable to add TLV to IMSG 0x07 V5 IDs not configured for this slot 0x08 Reserved Type 0x09-0x0F Reserved Also refer to common Response Status Values
	Number of AEs to follow	10	Number of TLVs to follow
	AEs 0x01 Slot 0x2C V5 ID 0x2D V5 ID, Link ID	10	Number of TLVs to follow
:	Query Type 0x01 Query all host-configured V5 IDs (uses Slot AIB). Lists TLVs that are configured per slot represented by the "V5 Create" TLV 0x02 Query all host-configured C Channels per V5 ID. Lists TLVs represented by the "V5 C Channel Assignment" TLV 0x03 Query all host-configured links per V5 ID. Lists TLVs represented by the "V5 Add Link" TLV 0x04 Query all other host-configured options per V5 ID. TLVs from the V5 Configure message are used in the response. The TLVs returned for this entity are as follows: • Variant ID (0x03) • Reserved type (0x08) • LE or AN side (0x05) • V5 Interface ID (0x10) 0x05 Query all host-configured user ports per V5 ID. Lists TLVs represented by the "Add V5.2 User Port Range" TLV. Shows all the configured user ports as ranges for a queried V5 ID. A maximum of 50 ranges can be returned in a single response. 0x06 Query the Service State of the V5 ID. A tag of "FF" is reported in the response. The service state of the V5 ID is reported in the response to this query. 0x07 Host-configured User Port Range. A TLV represented by the "Add V5.2 User Port Range" TLV will show one range of the lowest configured user port ID to the highest configured user port for the queried V5 ID. 0x08 Query all configured Cpaths. Lists TLVs represented by the "V5 C Path Assignment" TLV.	:	TLVs 0x0001 Create V5 ID 0x0003 V5 Variant ID 0x0004 V5 Variant Type 0x0005 V5 Side 0x0006 Add V5 User Port Range 0x0008 Reserved 0x0009 Reserved 0x000A V5 C Channel Assignment 0x000B V5 Cpath Assignment 0x000C V5 Add Link 0x000E Reserved 0x0010 V5 Interface ID
:	Reserved (0x00)	:
n+1	Checksum	n+1	Checksum