rprRingControl
rprRingControl - set up Ring Control header for RPR packets
SYNOPSIS
rprRingControl sub-command options
DESCRIPTION
The rprRingControl command is used to set up the content of RPR header used by all RPR packets except the RPR Fairness Frames, which are set up in the rprFairness command. The options are divided into Base Control and Extended Control options.
STANDARD OPTIONS
RPR Base Control Options
enableFairnessEligible
true | false
This 1-bit field indicates the eligibility of this packet for the fairness algorithm. Note that packets with serviceClass set to rprServiceClassA0 or rprServiceClassA1 are not eligible for fairness control. (default = true)
enableOddParity
true | false
If true, then the value of the transmitted parity is odd over the first two bytes (TTL and baseRingControl). If false, even parity is set. (default = true)
enableWrapEligible
true | false
This 1-bit field indicates whether the packet is wrap eligible.(default = false)
packetType
This 2-bit field indicates the type of the RPR packet.
Option |
Value |
Usage |
---|---|---|
rprControlPacket |
1 |
Control frame, expect for Fairness frames. |
rprDataPacket |
3 |
(default) Data frame. |
parityBit
Read only. The value of the parity associated with the ring control header. For use in RPR Fairness Frames only. The value of this field is influenced by the value of the enableOddParity field.
ringIdentifier
This 1-bit field is the Ringlet Identifier (RI), indicating the ringlet from which the RPR frame was first transmitted.
Option |
Value |
Usage |
---|---|---|
rprRinglet0 |
0 |
(default) Ringlet 0. |
rprRinglet1 |
1 |
Ringlet 1. |
serviceClass
This 2-bit field indicates the MAC service class for the frame.
Option |
Value |
Usage |
---|---|---|
rprServiceClassC |
0 |
Class C is the lowest level of traffic, transmitted on a best-efforts basis. None of the traffic has a guaranteed data rate, and no limits are placed on delay and jitter. ClassC traffic is eligible for use by the fairness algorithm. |
rprServiceClassB |
1 |
(default) Class B is the next higher service level, with an allocated and guaranteed data rate for a portion of the traffic, plus low delay and jitter (CIR). The additional traffic is transmitted with no guaranteed data rate (EIR) and is eligible for use by the fairness algorithm. |
rprServiceClassA1 |
2 |
Class A is the highest service level, providing an allocated and guaranteed data rate, plus low delay and jitter (CIR). It is not eligible for use by the fairness algorithm. There are two sub-classes, which are not distinguished to the MAC client: Class A1 and Class A0. Class A1 reserved bandwidth may be used by ClassB or ClassC traffic if not in current use. |
rprServiceClassA0 |
3 |
Class A0 may not be reused if not in current use. |
ttl
This 8-bit field indicates the Time to Live option of the RPR header. The TTL value is the first octet of an RPR frame header. This indicates the maximum number of hops to the destination. (default = 1)
RPR Extended Control Options
extendedFrame
This 1-bit field indicates that this data frame is sent from a MAC source which is not a node on the ring to a MAC destination that is not a node on the ring. If set to true, then the entire MAC layer packet is expected after the hec field in the RPR packet, including the destination and source MAC addresses. (default = 0)
floodingForm
This 2-bit field indicates whether the packet should be flooded and whether it should be flooded uni-directionally or bi-directionally.
Option |
Value |
Usage |
---|---|---|
rprFfNoFlood |
0 |
(default) No flooding. |
rprFfUnidirectionalFlood |
1 |
Flood only in the ringlet specified in ringIdentifier. |
rprFfBidirectionalFlood |
2 |
Flood to both ringlets. |
rprFfReserved |
3 |
Reserved |
passedSource
This 1-bit field is used by wrapping systems to prevent frame mis-order and duplication. It is normally set to 0 when a frame is first transmitted by a station and set to 1 when a wrapped frame passes the source station again. (default = 0)
reserved
A 3-bit reserved field for future use. It is normally set to 0's on transmission and ignored upon receipt. (default = 0)
strictOrder
This 1-bit field indicates whether strict ordering (1) or relaxed ordering (0) requirements should be observed. (default = 0)
ttlBase
If the value of packetType is rprDataPacket, then this 8-bit field should be set the original TTL of the data packet before RPR encapsulation. (default = 0)
COMMANDS
The rprRingControl command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
rprRingControl cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the rprRingControl command.
rprRingControl config option value
Modify the configuration options of the port. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for port. If option is specified with no value, then the commands returns a list of values available for this option.
rprRingControl decode capSlice chasID cardID portID
Decodes a slice/frame into the rprRingControl variables. If not an rprRingControl frame, returns TCL_ERROR. May be used to determine if the captured frame is a valid rprRingControl frame. Specific errors are:
- No connection to a chassis
- The captured frame is not an rprRingControl frame
- RPR is not a supported feature on this port
rprRingControl get chasID cardID portID
Gets the current configuration of the port with id portID on card cardID, chassis chasID from its hardware. This call must have been preceded by a call to rprRingControl set or stream get. Call this command before calling rprRingControl cget option value to get the value of the configuration option. Specific errors are:
- No connection to a chassis
- Invalid port number
- Data not available, do a stream get
rprRingControl set chasID cardID portID
Sets the configuration of the port in IxTclHAL with id portID on card cardID, chassis chasID by reading the configuration option values set by the rprRingControl config option value command. Specific errors are:
- No connection to a chassis
- Invalid port number
- The port is being used by another user
- The configured parameters are not valid for this port
- RPR is not a supported feature on this port
rprRingControl setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under rprFairness.
SEE ALSO
rprFairness, rprOam, rprProtection, rprTlvBandwidthPair, rprTlvIndividualBandwidth, rprTlvNeighborAddress, rprTlvStationName, rprTlvTotalBandwidth, rprTlvVendorSpecific, rprTlvWeight, rprTopology.