You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > EXNET Ring Configure 0x0074
SwitchKit Name
RingConfig
Type
EXS API and SwitchKit API message
Description
Use this message to configure the EXNET ring.
The configuration includes:
Logical Ring ID
EXNET-ONE Card Diagnostics
Prepare For Addition
Expand Ring
Loop Back Port
Add Node
Sent by
SwitchKit Code
Configuration
RingConfig (
Node = integer,
Slot = integer,
Ring = integer,
Entity = integer,
Data = byte array);
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE Entity;
UBYTE Data[222];
} XL_RingConfig;
C++ Class
class XLC_RingConfig : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
UBYTE getSlot() const;
void setSlot(UBYTE x);
UBYTE getEntity() const;
void setEntity(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 (0x0007) |
3, 4 |
Message Type (0x0074) |
3, 4 |
Message Type (0x0074) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
AIB (starting with byte 0) |
8, 9 |
|
10 |
Checksum |
||
: |
Entity |
|
|
: |
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 (0x0007) |
3, 4 |
Message Type (0x0074) |
3, 4 |
Message Type (0x0074) |
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 If the MSB of this field is 0x50 (NACK), the LSB indicates the NACK reason.
This value is returned when trying to set a node to be master-configurable, if the ring timing has already been derived.
A value of Action Denied (0xC0) is returned if the user is trying to set an EXNET-ONE card. |
Number of AEs to follow |
10 |
Checksum |
|
AEs
to configure these entities:
0x01 Logical Ring ID 0x04 EXNET T-ONE Card Diagostics 0x05 Prepare for Addition 0x06 Expand Ring 0x07 Loopback Port 0x08 Add Note
OR
|
|||
to configure these entities:
0x02 Transmit Mode 0x03 Number of Packets 0x04 EXNET-ONE Card Diagnostics 0x05 Prepare For Addition 0x06 Expand Ring 0x07 Loop Back Port 0x08 Add Node 0x09 Master-configurable 0x0A Ring Mode |
|||
: |
Entity 0x01Logical Ring ID 0x02Transmit Mode 0x03Configure Number of Packets 0x04EXNET-ONE Card Diagnostics 0x05Prepare For Addition0x06Expand Ring 0x07Loop Back Port 0x08Add Node0x09Master-configurable 0x0ARing Mode |
||
: |
Data |
||
|
0x01 Assign Ring Data[0] Logical Ring ID
Use the values below to de-assign a specific ring or all rings on a node:
|
||
|
0x02 Configure Transmit Mode Data[0] Transmit Mode 0x00 Receive Only 0x01 Transmit and Receive
|
||
|
0x03 Configure Number of Packets Data[0] Number of Packets 0x01 - No longer used. 0x03 - No longer used. 0x04 - Four packets (E1, J1, VDAC-ONE,
|
||
|
0x04 EXNET-ONE Card Diagnostics Data[0] EXNET-ONE Card Diagnostics 0x00 Reserved 0x01 Non-Forced*, Internal Loop Back 0x02 Non-Forced*, External** Loop Back 0x03 Forced, Internal Loop Back 0x04 Forced, External** Loop Back
*The Non-Forced mode is used to prevent execution of EXNET-ONE Card Diagnostics procedure while EXNET Ring is up and running. Performing EXNET-ONE Card Diagnostics will take the EXNET Ring out of service.
**The External Loop Back mode can be used when both I/O ports are externally looped back with fiber optic cabling. |
||
|
There is no data associated with this entity.
There is no data associated with this entity.
Node ID of the neighbor CSP node. This message must be sent to the node that Data[0] 0x00 Logical Node ID of node whose "B" port will be looped back. 0x08 Add Node There is no data associated with this entity.
|
||
|
0x09 Master-configurable The value of this field indicates whether or not a node is allowed to become the EXNET Ring Master. Valid entries for these fields, based on the value of the Entity field value 0x09, are as follows: Data[0] Allow Master Arbitration Flag. 0x00 Do not allow this node to participate in EXNET Ring Master
|
||
|
0x0A Ring Mode The Ring Mode entity configures the Enhanced Fault Tolerance Ring Mode. Data[0] Ring Mode 0x00 Reserved 0x01 Enhanced Fault Tolerance Ring Mode This mode adds enhanced Single Ring Redundancy with seamless switchover support, run-time software link validation, enhanced live This mode is recommended for homogenous second generation |
||
: |
Checksum |
Field |
Field Value to Deassign a Specific Ring |
Field Value to Deassign All Rings |
---|---|---|
AIB |
Slot # |
0xFF |
Entity |
0x01 (Assign Ring) |
|
Data[0] Logical Ring ID |
0xFF |