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

Ring Status Query 0x0071

SwitchKit Name

RingStatusQuery

Type

EXS API and SwitchKit API message

Description

Ring Status Query 0x0071

Use this message to query either the ring status or the ring configuration.

To Query Ring Configuration

Use the Ring Configuration Query address type in the AIB to query the ring configuration. See "Response Data" for the format of the data returned by the CSP.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[253];

} XL_RingStatusQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE Slot;

UBYTE Data[221];

} XL_RingStatusQueryAck;

C++ Class

class XLC_RingStatusQuery : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

};

C++ Class Response

class XLC_RingStatusQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(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 (0xNNNN)
3, 4 | Message Type (0x0071) | 3, 4 | Message Type (0x0071)
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, 9 | Status MSB, LSB
Number of AEs to follow | 10 : | AIB (same as message)
AEs | : | :
: | Checksum | : | Data
| : | :
: | Checksum

EXS API Hex Format - Detailed

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 (0x0071) | 3, 4 | Message Type (0x0071)
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, 9 | Status MSB, LSB
Number of AEs to follow | 10 : | AIB (same as message)
AE 0x01 Slot 0x3D Ring Configuration Query
: | Checksum
: | Data (also see Response Data section below this table) For a Ring Configuration Query, see the information below this table For a Ring Status Query, see the information directly below: Data[0] Logical Ring ID Data[1] Ring Status This field indicates 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 Data[2] More Status This field indicates the ring status information whenever the ring unexpectedly goes down. 0x00 EXNET Card Reset Host has taken ring out-of-service (normal reset) 0x01 Ring Configuration Incomplete 0x02 Waiting for Addition 0x05 Unsupported Ring Mod 0xF6 EXNET Card In Failed State: EXNET Card has reset too many times 0xF7 EXNET Card Reset: EXNET Card configuration information changed 0xF8 EXNET Card Reset: Remote node timed out 0xF9 EXNET Card Timed Out During Ring Initialization 0xFA Internal Diagnostics Failed 0xFB EXNET Card Isolated From Ring 0xFC Ring Out of Service: Internal failure 0xFE Not Receiving Light 0xFF Ring Out of Service Data[3] EXNET Port A Status This field indicates the status of EXNET port A. 0x00 Normal 0x01 Loop Back Data[4] EXNET Port B Status This field indicates the status of EXNET port B. 0x00 Normal 0x01 Loop Back Data[5] Master Status This field indicates whether or not this node is the master. 0x00 Not Master 0x01 Master Data[6] Transmit Mode This field indicates status of the transmit and receive mode. 0x00 Receive Only 0x01 Transmit/Receive
| Data[7] Source Packet Number This field indicates the ID number of the source packet. 0x00–0x1F Source Packet Number 0xFF Source Packet Number Unassigned Data[8] 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. Data[9] Redundancy State This field indicates redundancy state of the RICs: 0x00 No Redundancy 0x01 Active RIC 0x02 Standby RIC 0xFF Role Not Yet Defined Data[10] Current Ring Mode This field indicates the Ring Mode: 0x00 Normal Ring Mode 0x01 Enhanced Fault Tolerance Ring Mode
: | Checksum

Response Data

Ring Configuration Query

When querying the ring configuration, the following Data is returned.

Response Fields For Ring Configuration Query
Data[0] Number of Rings Configured
Data[1] Number of Unconfigured Nodes
Data[2] Logical Ring ID
Data[3] Ring Service State
Data[4] Number of Nodes on ring
Data[5] Ring Master Node ID
Data[6-9] Physical Node ID
Data[10-13] IP Address
Data[14] Logical Node ID
Data[15] Load Major Rev.
Data[16] Load Minor Rev.
Data[17] Load Build Number
Data[18] Transmit/Receive Mode

• Data[1] through Data[18] are repeated for each ring.

• Data[6] through Data[18] are repeated for each node on the ring.

See Address Information Block.
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.
Most Significant Bit
Least Significant Bit
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.
Excel's open architecture, proprietary, 1.3 Gbps fiber optic network using a packet-based protocol.
The point in the Excel platform where a DS0 connects to a network. Also known as a "socket."
Message delimiter (SS7 bit pattern - 01111110)
Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.