rprProtection
rprProtection - build RPR protection messages
SYNOPSIS
rprProtection sub-command options
DESCRIPTION
The rprProtection command is used to build RPR protection messages. Protection messages provide wrapping status information and indicates of a station's desires with respect to wrapping.
STANDARD OPTIONS
controlType
If enableOverrideControlType is set to true, then this is the new control type value to be set in the message.
Option |
Value |
Usage |
---|---|---|
rprDiscovery |
1 |
Discovery message. |
rprProtection |
2 |
Protection message. |
rprOamControl |
3 |
(default) OAM message. |
controlVersion
If enableOverrideControlVersion is set to true, then this is the new control version value to be set in the message. (default = 0)
enableOverrideControl
Type true | false
The message control type is normally set appropriately for the type of message being formatted. Setting this option to true, allows that type setting to be changed as specified in controlType. (default = false)
enableOverrideControl
Version true | false
The message control version is normally set to 0. Setting this option to true, allows that version setting to be changed as specified in controlVersion. (default = false)
headerChecksum
Read-only. The 16-bit header error (hec) checksum calculated over the control header.
jumboPreferred
Indicates a station's ability and/or preference to support jumbo frames. A false value indicates that the station cannot support jumbo frames or prefers not to do so. A true value indicates that the station can support jumbo frames and prefers to do so. (default = false)
protectionRequestEast
The RPR protection message type to report the protection state on the east interface of this station.
Option |
Value |
Usage |
---|---|---|
rprNoRequest |
0 |
(default) No requested type. |
rprWaitToRestore |
1 |
Wait to restore. |
rprManualSwitch |
2 |
Specifies that the indicated link should not be used. |
rprSignalDegrade |
3 |
A minor signal degradation condition exists. |
rprSignalFair |
4 |
A major signal degradation condition exists and the link may not be used. |
rprForcedSwitch |
5 |
Specifies that the indicated link may not be used. |
protectionRequestWest
The RPR protection message type to report the protection state on the west interface of this station. See protectionRequestEast for a list of choices and the default value.
sequenceNumber
This 8-bit field has a valid range of 0 to 63. This field is the sequence number used with all copies of a particular protection control message. The value is incremented only if the contents of the message packet change, ensuring that protection control messages are processed in the correct order. (default = 0)
wrapPreferred
Indicates a station's ability and/or preference to support wrapping protection. A false value indicates that the station cannot support wrap protection or prefers not to do so. A true value indicates that the station can support wrap protection and prefers to do so. (default = 0)
wrappingStatusEast
The wrapping status for the traffic received on the east interface of this station. A true value indicates that the traffic is wrapped, and a false value indicates that the traffic is not enabled. (default = false)
wrappingStatusWest
The wrapping status for the traffic received on the west interface of this station. A true value indicates that the traffic is wrapped, and a false value indicates that the traffic is not enabled. (default = false)
COMMANDS
The rprProtection command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
rprProtection 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.
rprProtection 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.
rprProtection decode capSlice chasID cardID portID
Decodes a slice/frame into the rprProtection variables. If not an rprProtection frame, returns TCL_ERROR. May be used to determine if the captured frame is a valid rprProtection frame. Specific errors are:
- Invalid port
- No connection to a chassis
- The captured frame is not an rprProtection frame
- RPR is not a supported feature on this port
rprProtection 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 rprProtection set or stream get. Call this command before calling rprProtection 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
rprProtection 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 rprProtection 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
rprProtection setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under rprFairness.
SEE ALSO
rprFairness, rprOam, rprRingControl, rprTlvBandwidthPair, rprTlvIndividualBandwidth, rprTlvNeighborAddress, rprTlvStationName, rprTlvTotalBandwidth, rprTlvVendorSpecific, rprTlvWeight, rprTopology.