V5 Configure 0x007B

SwitchKit Name

V5Config

Type

EXS API and SwitchKit API message

Description

This message configures V5-specific options.

Sent by

Host

SwitchKit Code

Configuration

V5Config (

ConfigType = integer,

TLVCount = integer);

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE ConfigType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_V5Config;

C++ Class

class XLC_V5Config : 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 getConfigType() const;

void setConfigType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

Response Status Indications

The following response status indications are available for the V5 Configure message:

0x01 Invalid V5 Interface ID

Internal slot initialization error for the V5 ID, or the host may be trying to:

• assign a V5 interface ID when this ID is already assigned in the Excel platform for the given network side (AN or LE).

• create a V5 ID that is greater than the maximum allowed.

• destroy a V5 ID that is greater than the maximum allowed.

• add a C Channel to a V5 ID that is not configured in the system.

• add a C Channel to a V5 ID that is greater than the maximum allowed.

• create a V5 ID that already exists.

0x02 Invalid TLV Length

One or more TLVs used in this message have an incorrect length.

0x03 Unrecognized TLV Tag

Unrecognized internal IMSG TLV tag was retrieved from IMSG.

0x04 Invalid V5 Variant ID

A null pointer was encountered while attempting to configure the V5 variant ID for a V5 ID.

0x05 Invalid V5 Variant Type

A null pointer was encountered while attempting to configure the V5 variant type.

0x06 Invalid Configuration Value

• The host may be attempting to configure the network side as AN or LE and has passed an invalid value for the network side.

• A null pointer was configured while attempting to configure the network side.

• The host may have sent an invalid value for the Configure Type.

0x07 Invalid User Port ID Range

• The host may be attempting to add a user port range when there were not enough free user port entries in the configuration database to accommodate the range.

• The host may be attempting to add a user port range when a user port ID within the desired range was already configured.

• The host may be attempting to add or remove a user port range that was invalid. The low range must be less than or equal to the high range and the total range must be less that or equal to the maximum allowed for each card.

See next RSV (0x08) for more information.

0x08 Invalid Tag ID

• The host may be attempting to add or remove a user port ID that is greater than the maximum allowed.

• The host may be attempting to add or remove a user port range that contained an incorrect user port type field.

• The host may be attempting to add or remove more ranges than are allowed (50).

• The host may have encountered a null pointer when attempting to add or remove user ports.

0x09 V5 Interface is In Service

The host may be attempting to add or remove a C Channel for an interface that was in service.

0x0A Invalid C Channel

• The host may be attempting to add or remove a C Channel that was greater than the maximum allowed per interface.

• The host may be attempting to add a C Channel to a timeslot that was already being used.

• The host may be attempting to add a C Channel with an invalid C Channel type value.

• The host may be attempting to add a C Channel to an interface that already has this logical C Channel assigned to it.

• The host was attempting to remove a C channel with an invalid C Channel ID.

0x0B Invalid Link ID

The host may be trying to:

• add a link with a span ID that is already assigned to another V5 interface.

• add a link when the link ID is already assigned to this V5 ID.

• add or remove a link ID that is greater than the maximum allowed.

• add a C Channel with a link ID that is not configured.

• remove a link that has a C Channel on it.

• add a link containing a C Channel to an interface that is in service.

• add a C Channel with a span ID that does not belong to the corresponding link ID.

• add a C Channel with a link ID that is greater than the maximum allowed.

• remove a link that is not configured.

0x0C Duplicate User Port Assignment Attempt

• The host may be attempting to add a duplicate user port ID to a V5 ID for a different Timeslot for V5.1.

• A null pointer was encountered