Product License Query 0x007A

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Product License Query 0x007A

SwitchKit Name

ProductLicenseQuery

Type

EXS API and SwitchKit API message

Description

This message is used to provide information about product licenses that are currently installed on the Excel platform.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

} XL_ProductLicenseQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE NumLicenses;

UBYTE Data[250];

} XL_ProductLicenseQueryAck;

C++ Class

class XLC_ProductLicenseQuery : public XLC_OutboundMessage {

public:

};

C++ Class Response

class XLC_ProductLicenseQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getNumLicenses() const;

void setNumLicenses(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 (0x0005)	1, 2	Length (0xNNNN)
3, 4	Message Type (0x007A)	3, 4	Message Type (0x007A)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
8	Checksum	7	Logical Node ID
	Response continued below.
8, 9	Status MSB: 0x4D If the MSB of the Status field is 0x4D (NACK), the LSB indicates the NACK reason. Status LSB: 0x01 Software Key Format Not Valid The first two bytes of the Product License field are not defined key types, or if the product license contains invalid data. 0x02 Data Decrypted Not Valid A serial number decrypted from a Product License cannot be matched against an existing serial number on the Excel platform. 0x03 Product License - Insufficient Licensed Resources 0x3D Product License - Invalid ICB Data 0x74 Invalid Card Type 0xAA Insufficient Hardware
10	Number of Licenses to follow
11	Data[0] The data varies by the Entity being queried. The entity can be determined by Key Type. The values below are repeated for each Product License: Hardware Upgrades Data[0-1] Card Serial Number The serial number of the card that has been updated. Data[2] Slot Number The number of the slot of the card that has been updated. Data[3] Number of Entities The number of licensed spans for T-ONE or E-ONE cards, or the number of licensed links for SS7 cards. Data[4-5] Key Type The specific type of Product License. The value is listed in the Product License ICB with the corresponding License Type. Data[6-19] Encrypted Key A 14-byte hexadecimal value representing the encrypted license data Software Upgrades Data[0-1] Chassis Serial Number The serial number of the Excel platform backplane. Data[2] Slot Number The value of this field is for the chassis, and is always 0x13. Data[3] Number of Entities The value of this field is for the chassis, and is always 0x01. Data[4-5] Key Type The specific type of Product License. Data[6-19] Encrypted Key A 14-byte hexadecimal value representing the encrypted license data
:	Checksum