You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Ring Status Report 0x0072

Ring Status Report 0x0072

SwitchKit Name

RingStatusReport

Type

EXS API and SwitchKit API message

Description

Ring Status Report 0x0072

This message informs the host of a ring’s status after its EXNET® status changes.

Sent by

CSP

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE RingID;

UBYTE RingStatus;

UBYTE MoreStatus;

UBYTE PortAStatus;

UBYTE PortBStatus;

UBYTE MasterStatus;

UBYTE TransmitMode;

UBYTE SourcePacketNum;

UBYTE MasterConfigurable;

UBYTE RedundancyState;

UBYTE RingMode;

} XL_RingStatusReport;

C++ Class

class XLC_RingStatusReport : public XLC_InboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getRingID() const;

void setRingID(UBYTE x);

UBYTE getRingStatus() const;

void setRingStatus(UBYTE x);

UBYTE getMoreStatus() const;

void setMoreStatus(UBYTE x);

UBYTE getPortAStatus() const;

void setPortAStatus(UBYTE x);

UBYTE getPortBStatus() const;

void setPortBStatus(UBYTE x);

UBYTE getMasterStatus() const;

void setMasterStatus(UBYTE x);

UBYTE getTransmitMode() const;

void setTransmitMode(UBYTE x);

UBYTE getSourcePacketNum() const;

void setSourcePacketNum(UBYTE x);

UBYTE getMasterConfigurable() const;

void setMasterConfigurable(UBYTE x);

UBYTE getRedundancyState() const;

void setRedundancyState(UBYTE x);

UBYTE getRingMode() const;

void setRingMode(UBYTE x);

};

Overview of message

The following table provides an overview of this message. The table following it, provides the detail for each byte.

MESSAGE (White) | RESPONSE (Gray(
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0xNNNN) | 1, 2 | Length (0x0005)
3, 4 | Message Type (0x0072) | 3, 4 | Message Type, MSB (0x0072)
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 | 8 | Checksum
Number of AEs to follow |
AEs
: | Logical Ring ID
: | Ring Status
: | More Status
: | EXNET® Port A Status
: | EXNET® Port B Status
: | Master Status
: | Transmit Mode
: | Source Packet Number
: | Master Arbitration Flag
: | Checksum

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 (0x0005)
3, 4 | Message Type (0x0072) | 3, 4 | Message Type (0x0072)
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 0x00 - Individual AEs | 8 | Checksum
Number of AEs to follow |
AE 0x01 Slot
: | Logical Ring ID
: | Ring Status The status of the ring to which this node belongs. 0x00 In Service: Ring capable of passing data 0x01 Ring Initializing: Validating integrity of the ring 0x02 Connected: Adjacent nodes are physically connected and seeing light 0xFE RIC Failure State: Must cycle the ring service state or run diagnostics 0xFF Out of Service: Ring is down and unable to pass data NOTE: Ring B is a backup ring, and the status indicates that the ring is initializing until the ring is brought into service due to the failure of Ring A.
: | More Status This field indicates further status information. 0x00 None 0x01 Ring Configuration Incomplete 0x02 Waiting for Addition 0x05 Unsupported Ring Mode 0xF6 EXNET® Card has reset too many times 0xF7 Ring Mastership Configuration Changed 0xF8 Remote node timed out 0xF9 Timed out during ring initialization 0xFA Internal Diagnostics Failed 0xFB EXNET® Card isolated from ring 0xFC Internal Failure 0xFE Not Receiving Light 0xFF Ring Out of Service Unknown Failure
: | EXNET® Port A Status These fields indicates the status of each of the EXNET® ports. 0x00 Normal 0x01 Loop Back
: | EXNET® Port B Status
: | Master Status This field indicates whether or not this node is the master. 0x00 Not Master 0x01 Master
: | Transmit Mode This field indicates status of the transmit and receive modes. 0x00 Receive Only 0x01 Transmit/Receive 0xFF Transmit Mode Unassigned
: | Source Packet Number This field indicates the ID number of the source packet. 0x00–0x1F Source Packet Number 0xFF Source Packet Number Unassigned
: | Master Arbitration Flag This field indicates whether or not a node is allowed to become EXNET® Ring Master: 0x01 This node is allowed to participate in EXNET® Ring Master Arbitration. 0x00 This node is not allowed to participate in EXNET® Ring Master Arbitration.
: | Checksum

Redundancy State

This field indicates redundancy state of the RICs:

0x00 No Redundancy

0x01 Active RIC

0x02 Standby RIC

0xFF Role Not Yet Defined

Current Ring Mode

This field indicates the Ring Mode:

0x00 Normal Ring Mode

0x01 Enhanced Fault Tolerance Ring Mode

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.
Most Significant Bit
See Address Information Block.
The point in the Excel platform where a DS0 connects to a network. Also known as a "socket."
Message delimiter (SS7 bit pattern - 01111110)
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.