rprOam
rprOam - build RPR OAM messages
SYNOPSIS
rprOam sub-command options
DESCRIPTION
The rprOam command is used to build RPR OAM (Operations, Administration, Management) messages. These messages are sent between stations to determine the operational status of the connection. There are three types of messages:
- Echo request and response frames: to determine connectivity.
- Flush frames: to prevent mis-ordering of frames.
- Vendor specific frames: for carrying a vendor's OAM information.
STANDARD OPTIONS
flushReserved
A 4-bit field reserved for future use, to be used only when typeCode is rprOamFlush. (default = 0)
requestProtectionMode
Indicates the protection mode of the request; used by the receiving station to determine which ringlet to respond on.
Option |
Value |
Usage |
---|---|---|
rprOamProtected |
0 |
Protected. |
rprOamUnProtected |
1 |
(default) Not protected. |
requestReserved
Read-only. A 4-bit field reserved for future use.
requestRinglet
The requested response ringlet.
Option |
Value |
Usage |
---|---|---|
rprOamReplyOnDefault |
0 |
Reply using the default calculation. |
rprOamReplyOnRinglet0 |
1 |
Reply on ringlet 0. |
rprOamReplyOnRinglet1 |
2 |
(default) Reply on ringlet 1. |
rprOamReplyReserved |
3 |
Reserved for future use. |
responseProtection
Mode
Holds the same value of the requestProtectionMode for a received echo request. (default = rprOamUnProtected)
responseReserved
Read-only. A 4-bit field reserved for future use.
responseRinglet
Holds the same value of the requestRinglet for a received echo request. (default = $::rpmOamReplyOnRinglet1)
typeCode
The OAM type code for the message.
Option |
Value |
Usage |
---|---|---|
rprOamFlush |
1 |
Flush message. |
rprOamEchoRequest |
8 |
Echo request message. |
rprOamEchoResponse |
9 |
(default) Echo response message. |
rprOamVendorSpecific |
15 |
Vendor specific message. |
typeReserved
Read-only. A 4-bit field reserved for future use.
vendorOui
This option is used only when typeCode has a value of rprOamVendorSpecific and is the 3-octet IEEE company identifier for this vendor. The user data for this command may be set in the stream's background data. (default = {55 55 77})
COMMANDS
The rprOam command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
rprOam 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.
rprOam 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.
rprOam decode capSlice chasID cardID portID
Decodes a slice/frame into the rprOam variables. If not an rprOam frame, returns TCL_ERROR. May be used to determine if the captured frame is a valid rprOam frame. Specific errors are:
- No connection to a chassis
- RPR is not a supported feature on this port
rprOam 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 rprOam set or stream get. Call this command before calling rprOam 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
rprOam 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 rprOam 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
rprOam setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under rprFairness.
SEE ALSO
rprFairness, rprProtection, rprRingControl, rprTlvBandwidthPair, rprTlvIndividualBandwidth, rprTlvNeighborAddress, rprTlvStationName, rprTlvTotalBandwidth, rprTlvVendorSpecific, rprTlvWeight, rprTopology.