srpIps
srpIps - configure an SRP IPS protection control packet
SYNOPSIS
srpIps sub-command options
DESCRIPTION
The srpIps command is used to configure the contents of an SRP Intelligent Protection Switching (IPS) packet to be transmitted as part of a stream.
STANDARD OPTIONS
controlCheckSumMode
The checksum mode associated with the control packet.
Option |
Value |
Usage |
---|---|---|
srpIpsCheckSumBad |
0 |
Insert a bad checksum. |
srpIpsCheckSumGood |
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 = 2)
controlTypeOverride
true | false
Indicates whether the value in controlType should be used to override the default setting of srpControlTypeIps. (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. |
pathIndicator
Determines whether the control packet is sent only to an adjacent node or around the entire ring.
Option |
Value |
Usage |
---|---|---|
srpIpsPathIndicatorShort |
0 |
Message is just send to the next node. |
srpIpsPathIndicatorLong |
1 |
(default) Message is sent around the entire ring. |
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)
requestType
The type of IPS request.
Option |
Value |
Usage |
---|---|---|
srpIpsRequestTypeNoRequest |
0 |
(default) No request. |
srpIpsRequestTypeWaitToRestore |
5 |
Wait to restore. Instead of unwrapping immediately after a failure condition or manual request has been cleared, the node waits for a configured period of time before unwrapping |
srpIpsRequestTypeManualSwitch |
6 |
Manual switch. Force a switch. |
srpIpsRequestTypeSignalDegrade |
8 |
Signal degrade. A switch initiated by detecting line BER above a specific threshold or excessive CRC errors. |
srpIpsRequestTypeSignalFail |
11 |
Signal fail. A switch initiated by detecting los of signal, los of frame, line bit error rate above a specific threshold, line AIS or excessive CRC errors. |
srpIpsRequestTypeForcedSwitch |
13 |
Forced switch. Force a switch; same as manual switch but with higher priority. |
ringIdentifier
Indicates whether the inner or outer ring is to receive the packet. Used by the IPS 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. |
statusCode
Indicates the state of a node in terms of traffic wrapping.
Option |
Value |
Usage |
---|---|---|
srpIpsStatusCodeIdle |
0 |
(default) The node is prepared to perform protection switching if necessary. |
srpIpsStatusCodeProtection |
2 |
Indicates that a node is currently participating in a protection switching operation. |
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 srpIps command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
srpIps cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the srpIps command.
srpIps config option value
Modify the configuration options of the srpIps. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for srpIps.
srpIps decode capSlice [chasID cardID portID]
Decodes a captured slice/frame into the srpIps variables. If not an srpIps frame, returns TCL_ERROR. May be used to determine if the captured frame is a valid srpIps frame. Specific errors are:
- No connection to a chassis
- The captured frame is not an srpIps frame
srpIps get chasID cardID portID
Gets the current configuration of the srpIps frame for port with id portID on card cardID, chassis chasID. from its hardware. Call this command before calling srpIps cget option value to get the value of the configuration option. Specific errors are:
- No connection to a chassis
- Invalid port number
srpIps set chasID cardID portID
Sets the configuration of the srpIps in IxHAL for port with id portID on card cardID, chassis chasID by reading the configuration option values set by the srpIps 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
srpIps setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples under srpArp