You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Loop Back Configure/Query 0x0091

Loop Back Configure/Query 0x0091

SwitchKit Name

LoopBackConfig

Type

EXS API and SwitchKit API message

Description

Loop Back Configure/Query 0x0091

This message allows you to enable or disable loopback diagnostics on the
E-ONE, DS3, and T-ONE line cards. Also, this message will query the loopback mode configured on the card.

Example: The span must be out of service before you send it this message.

Sent By

Host

SwitchKit Code

Configuration

LoopBackConfig (

Node = integer,

Span = integer,

LoopbackType = integer);

C Structure

typedef struct {

unsigned short Span;

UBYTE LoopbackType;

} XL_LoopBackConfig;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short Span;

UBYTE LoopbackType;

UBYTE LoopbackStatus;

} XL_LoopBackConfigAck;

C++ Class

class XLC_LoopBackConfig : public XLC_SpanMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getLoopbackType() const;

void setLoopbackType(UBYTE x);

};

C++ Class Response

class XLC_LoopBackConfigAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getLoopbackType() const;

void setLoopbackType(UBYTE x);

UBYTE getLoopbackStatus() const;

void setLoopbackStatus(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 (0x000E)
3, 4 | Message Type (0x0091) | 3, 4 | Message Type (0x0091)
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 Fields after the response status exist only if the response status is a positive acknowledgment.
Number of AEs to follow
AE 0x0C Logical Span
: | Action This field indicates the loopback mode of the span. 0x00 Disable Local Loopback 0x01 Enable Local Loopback 0x02 Cancel Remote Loopback (DS3 only) 0x03 Request Remote Loopback (DS3 only) 0xFF Query Loopback | 10 | AIB (Individual AEs) Same as message
: | Data For Actions other than Query Loopback, this field is 0x00. For Action of Query Loopback (0xFF): Data [0] Action 0x00 Disable Local Loopback 0x01 Enable Local Loopback 0x02 Cancel Remote Loopback (DS3 only) 0x03 Request Remote Loopback (DS3 only) Data [1] Loopback Status (for DS3 only) 0x00 Remote Loopback Cancelled 0x01 Remote Loopback Requested
: | Checksum | : | Checksum

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.
Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
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
A type of diagnostic test in which the transmitted signal is returned to the sending device after passing through a data communications link or network.