srpDiscovery
srpDiscovery - configure an SRP discovery packet
SYNOPSIS
srpDiscovery sub-command options
DESCRIPTION
The srpDiscovery command is used to configure the contents of an SRP discovery packet to be transmitted as part of a stream. The bindings are configured in the srpMacBinding command and then added to the discovery packet using the addMacBinding sub-command.
STANDARD OPTIONS
controlCheckSumMode
The checksum mode associated with the control packet.
Option |
Value |
Usage |
---|---|---|
srpDiscoveryCheckSumBad |
0 |
Insert a bad checksum. |
srpDiscoveryCheckSumGood |
1 |
(default) Insert a good checksum. |
controlTTL
The control layer hop-count that is decremented by one each time a node forwards a control packet. (default = 0)
controlType
An alternate setting for the control type setting in the packet; controlTypeOverride must be set to true for this value to be used. (default = 1)
controlTypeOverride
true | false
Indicates whether the value in controlType should be used to override the default setting of srpControlTypeDiscovery. (default = false)
controlVersion
The version number associated with the control type fields. The only supported version is version 0. (default = 0)
controlVersionOverride
true | false
Indicates whether the value in controlVersion should be used to override the default setting of 0. (default = false)
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. |
originatorMacAddress
The original source MAC address. This differs from the source MAC address in that as a packet is forwarded from node to node, the source MAC address is modified to reflect the current node, whereas the originator MAC address always reflects the first source address. (default = {00 00 00 00 00 00})
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 Discovery 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. |
topologyLength
The length of the topology discovery packet beginning with the MAC type/MAC binding data. This must be a multiple of seven since each binding is seven bytes long. (default = 0)
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)
COMMANDS
The srpDiscovery command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
srpDiscovery addMacBinding
Adds the MAC binding found in the srpMacBinding command to the list associated with the discovery packet.
srpDiscovery cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the srpDiscovery command.
srpDiscovery clearAllMacBindings
Clears all of the MAC bindings associated with the discovery packet.
srpDiscovery config option value
Modify the configuration options of the srpDiscovery. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for srpDiscovery.
srpDiscovery decode capSlice chasID cardID portID
Decodes a captured slice/frame into the srpDiscovery variables. If not an srpDiscovery frame, returns TCL_ERROR. May be used to determine if the captured frame is a valid srpDiscovery frame. Specific errors are:
- No connection to a chassis
- The captured frame is not an srpDiscovery frame
srpDiscovery delMacBinding macBindingAddress
Deletes the MAC binding which matches macBindingAddress.
srpDiscovery get chasID cardID portID
Gets the current configuration of the srpDiscovery frame for port with id portID on card cardID, chassis chasID. from its hardware. Call this command before calling srpDiscovery cget option value to get the value of the configuration option. Specific errors are:
- No connection to a chassis
- Invalid port number
srpDiscovery getFirstMacBinding
Accesses the first MAC binding in the list and moves the data to the srpMacBinding command.
srpDiscovery getMacBinding macBindingAddress
Accesses the MAC binding in the list which uses macBindingAddress and moves the data to the srpMacBinding command.
srpDiscovery getNextMacBinding
Accesses the next MAC binding in the list and moves the data to the srpMacBinding command.
srpDiscovery set chasID cardID portID
Sets the configuration of the srpDiscovery in IxHAL for port with id portID on card cardID, chassis chasID by reading the configuration option values set by the srpDiscovery config option value command. Specific errors are:
- No connection to a chassis
- Invalid port number
- The port is being used by another user
- Configured parameters are not valid for this setting
srpDiscovery setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under srpArp