srpUsage

srpUsage - configure an SRP Usage packet

SYNOPSIS

srpUsage sub-command options

DESCRIPTION

The srpUsage command is used to configure the contents of an SRP Usage packet to be transmitted at intervals.

STANDARD OPTIONS
mode

Indicates the mode of the packet.

Option

Value

Usage

srpModeReserved000

0

 

srpModeReserved001

1

 

srpModeReserved010

2

 

srpModeATMCell

3

An ATM data cell.

srpModeControlMessage1

4

A control message to be passed to the destination host.

srpModeControlMessage2

5

A control message to be buffered for the destination host.

srpModeUsageMessage

6

(default) An SRP usage message.

srpModePacketData

7

An SRP data packet.

parityBit

The parity over the other SRP header bits.

Option

Value

Usage

srpParityBitEven

0

Insert an even parity bit.

srpParityBitOdd

1

(default) Insert a correct, odd parity.

priority

Indicates the priority of the SRP packet. Eight priority levels (0 through 7) are offered. Packets on the ring are treated as low or high priority, where a threshold variable determines which values fall into the high priority range. This value is usually copied from the IP precedence bits. Control packets always use priority 7. (default = 0)

ringIdentifier

Indicates whether the inner or outer ring is to receive the packet. Used by the Usage to make decisions about ring wrap or to determine whether or not a packet is accepted on the ring.

Option

Value

Usage

srpRIngIdentifierOuter

0

(default) Outer ring.

srpRIngIdentifierInner

1

Inner ring.

rxMacAddress

The source MAC address for the usage packet. (default = {00 00 00 00 00 00})

rxTimeout

The time interval, in microseconds, between SRP usage packets, which serve a keep-alive function. This must be between 8 to 65000 and should be set to approximately 106 microseconds. (default = 106)

rxTimeoutThreshhold

The number of timeout values that can pass before the sending interface is considered down. This value must be between 1 and 31 and should be set to 16. (default = 16)

ttl

The hop counter decremented each time a node forwards a packet. When the counter reaches 0, the packet is removed from the ring. This may be set from 0 through 255. (default = 1)

txMacAddress

The MAC address of the destination to which usage packets are sent. (default = {00 00 00 00 00 00})

txRepeatInterval

The interval within which usage frames are sent to upstream nodes; expressed in microseconds. This value must be between 10 and 65000. (default = 106)

txReserved

A reserved field, that should be set to 0. (default = 0)

txUsageEnabled

true | false

If set to true, periodic SRP usage packets are transmitted. (default = false)

txValue

The value associated with the usage packet, between 0 and 65535. (default = 65535)

COMMANDS

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

srpUsage cget option

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

srpUsage config option value

Modify the configuration options of the srpUsage. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for srpUsage.

srpUsage get chasID cardID portID

Gets the current configuration of the srpUsage frame for port with id portID on card cardID, chassis chasID. from its hardware. Call this command before calling srpUsage cget option value to get the value of the configuration option. Specific errors are:

srpUsage set chasID cardID portID

Sets the configuration of the srpUsage in IxHAL for port with id portID on card cardID, chassis chasID by reading the configuration option values set by the srpUsage config option value command. Specific errors are:

srpUsage setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See examples under srpArp

SEE ALSO

srpArp, srpDiscovery, srpIps