You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > IP Address Configure 0x00E7

IP Address Configure 0x00E7

SwitchKit Name

IPAddressConfig

Type

EXS API and SwitchKit API message

Description

IP Address Configure 0x00E7

Use this message to configure the subnet mask and assign either a single IP address or all IP addresses at once. You do this by matching the number of TLVs to the number of IP addresses being assigned.

You can clear IP addresses by setting all of the IP address and subnet mask data to 0xFF. If you plan to take a card with IP addresses from one chassis and insert it into another chassis, be sure to clear all IP addresses on the card first. Otherwise, there might be a conflict with the IP addresses of the cards in the new chassis.

NFS for DSP Series 2 card

To use TFTP or NFS, the DSP Series 2 card must be assigned an IP Address.

Gateway Address

In order to assign a Gateway IP Address to a VDAC mother board or any of the four modules, you must include the Gateway IP TLV in the same message as the IP Address Configure. You can not assign a Gateway IP Address in a message where the Gateway IP Address is the only TLV in the message.

Sent by

Host

SwitchKit Code

Configuration

IPAddress Config (

Node = integer,

Slot = integer,

DataType = integer,

TLVCount = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE Slot;

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_IPAddressConfig;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE TLVCount;

UBYTE Data[250];

} XL_IPAddressConfigAck;

C++ Class

class XLC_IPAddressConfig : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_IPAddressConfigAck : 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 (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0xNNNN) | 1, 2 | Length (0x000B)
3, 4 | Message Type (0x00E7) | 3, 4 | Message Type (0x00E7)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status MSB, LSB 0x08 Invalid TLV Combiation (You must include either the 0x02 Engage IP or 0x03 Reset IP TLV when configuring.)
Number of AEs to follow
AE 0x01 Slot
: | Data Type (0x00) TLVs | 10 | TLV 0x04 Reset Indicator
: | Number of TLVs | : | Checksum
: | TLV 0x01 Module, IP Address, and Subnet Mask 0x02 Engage IP * 0x03 Reset IP * 0x04 Reset Indicator 0x05 Gateway IP 0x09 Ethernet Link Redundancy 0x14 Reset VDAC Module 0x0A Activate Ethernet Port * Either the 0x02 Engage IP or 0x03 Reset IP must be included when configuring the VDAC-ONE card.
: | Checksum

Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
Digital Signal Processor
A 32-bit address, used in IP routing, which includes a Network address identifier assigned by a central authority and a Host ID (an end station identifier assigned by a LAN administrator).
A device that translates calls between an IP network and another network, typically the PSTN.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
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.
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