Product License Download 0x0079

SwitchKit Name

ProductLicenseDownload

Type

EXS API and SwitchKit API message

Description

This message is used to download one software key. Regardless of how a software or hardware module has been locked, you unlock all functionality with this message.

This message provides the mechanism for a host application to send the software feature or hardware upgrade license codes to the Excel platform. In a multi-node system, any node will accept and recognize these software feature licenses.

NOTES: For SwitchKit, when resetting a card such as, a T_ONE, E-ONE or J-ONE, a ProductLicenseDownload message is sent by SwitchManager so that the licensed hardware is available after a card reset. If the licensed card is permanently removed and the corresponding ProductLicenseDownload is not removed from the configuration, then any subsequent resets of matching card types will cause the ProductLicenseDownload to be NACKed.

Sent by

Host

Example Message (Socket Log Output for SwitchKit)

The following socket log output/example message enables SIP software.

00 19 00 79 00 00 ff 01 02 24 10 30 38 42 50 43 4b 4b 48 49 42 32 34 54 50 4f 4b

SwitchKit Code

Configuration

ProductLicenseDownload (

Node = integer,

ICBCount = integer,

ICBData = byte array);

C Structure

typedef struct {

UBYTE ICBCount;

UBYTE ICBData[252];

} XL_ProductLicenseDownload;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Slot;

} XL_ProductLicenseDownloadAck;

C++ Class

class XLC_ProductLicenseDownload : public XLC_OutboundMessage {

public:

UBYTE getICBCount() const;

void setICBCount(UBYTE x);

const UBYTE *getICBData() const;

UBYTE *getICBData();

void setICBData(UBYTE *x);

};

C++ Class Response

class XLC_ProductLicenseDownloadAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSlot() const;

void setSlot(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 (0x0079)

3, 4

Message Type (0x0079)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Number of ICBs to follow (Ignore this field if no ICBs in message.)

8, 9

Status MSB:

0x4D If the MSB of the Status field is
0x4D (NACK), the LSB indicates
the NACK reason.

 

 

9

ICB (Data Type)

0x24 Product License

:

Checksum

8, 9 (cont)

Status LSB:

0x01 Software Key Format Not Valid

The first two bytes of the Product License field are not defined key types,
or 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

Data

For hardware upgrades, this field provides the slot number of the card that has been
updated.

 

For software module upgrades, this field is always "0".

11

Checksum