You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Virtual Span Control 0x00E2

Virtual Span Control 0x00E2

SwitchKit Name

VirtualSpanControl

Type

EXS API and SwitchKit API message

Description

Virtual Span Control 0x00E2

This message is used by the host to indicate to the CSP the Layer 1 state of a Virtual Span.

Sent

Host

Example Message

The following example brings all virtual spans in the node into service.

00 0E 00 E2 00 00 FF 00 01 0C 02 00 00 00 01 00

SwitchKit Code

Configuration

VirtualSpanControl (

Node = integer,

Span = integer,

Event = integer,

Data = byte array);

C Structure

typedef struct {

unsigned short Span;

UBYTE reserved19[28];

unsigned short Event;

UBYTE Data[221];

} XL_VirtualSpanControl;

C++ Class

class XLC_VirtualSpanControl : public XLC_SpanMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

unsigned short getEvent() const;

void setEvent(unsigned short 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 (0xNNNN)
3, 4 | Message Type (0x00E2) | 3, 4 | Message Type (0x00E2)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x01 Individual | 8, 9 | Status MSB, LSB 0x0012 Invalid Span Invalid Span was passed from host. 0x001D Invalid Event Type Host specified an invalid event type. 0x0063 Unassigned Span The logical span specified has not been assigned.
Number of AEs to follow 0x01 | 10 | Checksum
AEs 0x0C Logical Span |
: | Event MSB, LSB 0x00 Span is Non-operational (same as Loss of Signal at Layer 1) 0x01 Span is Operational (same as No Loss of Signal at Layer 1)
: | Data[0] ICB Count. This should always be sent from the host as 0x00.
: | Checksum

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 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
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.
See Information Control Block.