rprTlvIndividualBandwidth

rprTlvIndividualBandwidth - set up a TLV individual bandwidth item for use in an RPR topology message

SYNOPSIS

rprTlvIndividualBandwidth sub-command options

DESCRIPTION

The rprTlvIndividualBandwidth command is used to set up the content of an RPR Individual Bandwidth TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprIndividualBandwidth command.

This command's data is constructed by adding rprTlvBandwidthPairs. Bandwidth pairs are constructed through the use of the rprTlvBandwidthPair command and then added to this command with the rprTlvIndividualBandwidth addBandwidthPair command. Each bandwidth pair corresponds to the reserved bandwidth between this node and a node a number of hops away from this node. The first item in the pair represents the reserved bandwidth on ringlet 0 and the second represents the reserved bandwidth on ringlet 1.

Bandwidth pairs must be added in order; that is, for the node one hop away, followed by the node two hops away, etc.

An individual bandwidth TLV may be retrieved from the topology TLV list by calling rprTopology getFirstTlv/getNextTlv, checking for type = rprIndividualBandwidth and then inspecting the options in this command.

STANDARD OPTIONS

TLV Common Options

dataLength

Read-only. The 10-bit length of the data fields.

reserved1

Read-only. The 6-bit Reserved1 field is set to 0 and ignored by receiving nodes.

reserved2

Read-only. The 6-bit Reserved2 field is set to 0 and ignored by receiving nodes.

type

Read-only. The 10-bit TLV type field, set to rprIndividualBandwidth (3).

Individual Bandwidth TLV Specific Options

none

 

COMMANDS

The rprTlvIndividualBandwidth command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands.

rprTlvIndividualBandwidth addBandwidthPair

Adds the bandwidth pair constructed in rprTlvBandwidthPair to the list of pairs. Specific errors include:

rprTlvIndividualBandwidth cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the rprTlvIndividualBandwidth command.

rprTlvIndividualBandwidth clearAllBandwidthPairs

Clears all the bandwidth pairs.

rprTlvIndividualBandwidth getFirstBandwidthPair

Access the first bandwidth pair in the list. The pair's values may be read using the rprTlvBandwidthPair command. Specific errors are:

rprTlvIndividualBandwidth getNextBandwidthPair

Access the next bandwidth pair in the list. The pair's values may be read using the rprTlvBandwidthPair command. Specific errors are:

rprTlvIndividualBandwidth setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See examples under rprFairness.

SEE ALSO

rprFairness, rprOam, rprProtection, rprRingControl, rprTlvBandwidthPair, rprTlvNeighborAddress, rprTlvStationName, rprTlvTotalBandwidth, rprTlvVendorSpecific,rprTlvWeight, rprTopology.