sonet
sonet - configure the sonet properties of a POS port of a card on a chassis.
SYNOPSIS
sonet sub-command options
DESCRIPTION
The sonet command is used to configure the sonet properties of a POS port of a card on a chassis. Note: sonet error insertion is now handled by the sonetError command; sonet commands related to error insertion are now deprecated.
Note: the setDefault sub-command sets all options at default values, as indicated here. These values are a consistent setting for an OC12 card and may or may not be appropriate for other cards. In general, the sequence:
sonet setDefault
sonet set $chassis $card $port
fails.
The port setFactoryDefaults command, which relates to a particular port, sets all sonet options at default values appropriate for the type of port. The sequence:
port setFactoryDefaults $chassis $card $port
sonet set $chassis $card $port
always succeeds. If the use of setFactoryDefaults is undesirable, it is still essential that the value of interfaceType be set to a particular value after use of setDefault.
When the headerType is set to sonetGfp, the GFP header and overhead are set in the gfp and gfpOverhead commands.
STANDARD OPTIONS
apsType
Sets the Automatic Protection Switching (APS) bytes. Options include:
Option |
Value |
Usage |
---|---|---|
linearAps |
0 |
(default) The K1 and K2 Automatic Protection Switching (APS) bytes bit definitions represent a linear topology. |
ringAps |
1 |
The K1 and K2 Automatic Protection Switching (APS) bytes bit definitions represent a ring topology. |
C2byteExpected
Received path signal label. (default = 22)
C2byteTransmit
Register-programmable path signal label. (default = 22)
customK1K2
true/false
Enables or disables custom K1K2. (default = false)
dataScrambling
true/false
Enables or disables data scrambling in the sonet framer. (default = true)
enableCiscoSrp
Enables the use of the particular packet formats for Cisco's implementation of SRP. header must be set to sonetSrp for this flag to have any effect. (default = false)
header
Enable sonet header type. Options include:
Option |
Value |
Usage |
---|---|---|
sonetHdlcPppIp |
0 |
(default) |
sonetCiscoHdlc |
1 |
|
sonetOther |
2 |
|
sonetFrameRelay1490 |
3 |
|
sonetFrameRelay2427 |
3 |
|
sonetFrameRelayCisco |
4 |
|
sonetSrp |
5 |
not supported in channelized mode |
sonetCiscoHdlcIpv6 |
6 |
|
sonetHdlcPppIso |
7 |
|
sonetRpr |
8 |
not supported in channelized mode |
sonetAtm |
9 |
|
sonetGfp |
10 |
Generic Framing Protocol. |
sonetLaps |
12 |
Link Access Procedure |
interfaceType
Sets the type/speed of the sonet interface. Options include:
Option |
Value |
Usage |
---|---|---|
oc3 |
0 |
|
oc12 |
1 |
(default) |
oc48 |
2 |
|
stm1c |
3 |
|
stm4c |
4 |
|
stm16c |
5 |
|
oc192 |
6 |
|
stm64c |
7 |
|
ethOverSonet |
8 |
|
ethOverSdh |
9 |
|
k1NewState
Enables the K1 byte code value to be sent in the Sonet frame. (It is used by sonnet APS (automatic protection switching) to implement a bit-oriented protocol for critical switching operations). (default = 0)
k2NewState
Enables the K2 byte code value as in k1NewState. (default = 0)
lineErrorHandling
true/false
Enables/disables line error handling on the sonet interface. (default = false)
lineScrambling
true/false
Enables or disables line scrambling in the sonet framer. Applies only to the POS/sonet interface ports. (default = true)
operation
Sets up the sonet interface/operation either as normal mode or loopback mode. Options include:
Option |
Value |
Usage |
---|---|---|
sonetNormal |
0 |
(default) |
sonetLoopback |
1 |
|
sonetLineLoopback |
2 |
|
sonetFramerParallelDiagnostic |
3 |
|
sonetFramerDiagnosticLoopback |
4 |
|
sonetFecDiagnosticLoopback |
5 |
|
sonetFecLineLoopback |
6 |
|
pathErrorHandling true/false
Enables or disables path error handling on the sonet interface. (default = false)
rprHecSeed
When RPR is used, this setting is used to indicate the HEC (Hardware Error Correction) seed value. Options include:
Option |
Value |
Usage |
---|---|---|
hecSeed)x0000 |
0 |
(default) 0 value |
hecSeed0xffff |
1 |
0xFFFF value. |
rxCrc
Sets the receive CRC mode. Options include:
Option |
Value |
Usage |
---|---|---|
sonetCrc16 |
0 |
Selects reception with 16 bit CRC |
sonetCrc32 |
1 |
(default) Selects reception with 32 bit CRC |
trafficMap
Sets the Tcl hardware transmit mode. Options include:
Option |
Value |
Usage |
---|---|---|
sonetMapSpe |
0 |
(default) SPE = Synchronous Payload Envelope packet streams |
sonetMapDcc |
1 |
DCC = Data Communications Channel packet flows |
txCrc
Sets the transmit CRC mode. Options include:
Option |
Value |
Usage |
---|---|---|
sonetCrc16 |
0 |
Selects transmission with 16 bit CRC |
sonetCrc32 |
1 |
(default) Selects transmission with 32 bit CRC |
useRecoveredClock
Set the sonet framer to use no clock, the recovered clock or an external clock. Options include:
Option |
Value |
Usage |
---|---|---|
sonetNoClock |
0 |
No clock is used. |
sonetRecoveredClock |
1 |
(default) Use the recovered clock. |
sonetExternalClock |
2 |
Use the external clock. |
DEPRECATED
STANDARD OPTIONS
B1 true/false
B2 true/false
B3 true/false
errorDuration
insertBipErrors
true/false
lossOfFrame
true/false
lossOfSignal
true/false
periodicB1
true/false
periodicB2
true/false
periodicB3
true/false
periodicLossOfFrame true/false
periodicLossOfSignal
true/false
COMMANDS
The sonet command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
sonet cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the sonet command.
sonet 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.
sonet get chasID cardID portID
Gets the current configuration of the port with id portID on card cardID, chassis chasID. from its hardware. Call this command before calling sonet cget option value to get the value of the configuration option. Specific errors are:
- No connection to a chassis
- Invalid port number
sonet 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 sonet 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
- The port is not a Packet over Sonet port or 10Gigabit WAN.
sonet setDefault
Sets to IxTclHal default values for all configuration options.
sonet write chasID chardID portID
Writes or commits the changes in IxHAL to hardware for port portID, card cardID, chassis chasID. Before using this command, use the sonet set command to configure the stream related options in IxHAL.
EXAMPLES
package require IxTclHal
# Connect to chassis and get chassis ID
set host localhost
set username user
# Check if we're running on UNIX - connect to the TCL Server
# which must be running on the chassis
if [isUNIX] {
if [ixConnectToTclServer $host] {
ixPuts "Could not connect to $host"
return 1
}
}
# Now connect to the chassis
if [ixConnectToChassis $host] {
ixPuts $::ixErrorInfo
return 1
}
# Get the chassis ID to use in port lists
set chas [ixGetChassisID $host]
# Assuming that an OC48 POS card is in slot 18
set card 18
set portList [list [list $chas $card 1]]
# Login before taking ownership
if [ixLogin $username] {
ixPuts $::ixErrorInfo
return 1
}
# Take ownership of the ports we'll use
if [ixTakeOwnership $portList] {
ixPuts $::ixErrorInfo
return 1
}
# Get the type of card and check if it's the correct type
card get $chas $card
set type [card cget -type]
if {$type != $cardPosOc48} {
ixPuts "Card $card is not an OC48c POS card ($type)"
return 1
}
# Reset to the defaults and then set several values
sonet setDefault
sonet config -interfaceType oc48
sonet config -header sonetCiscoHdlc
sonet config -lineErrorHandling enable
sonet config -rxCrc sonetCrc16
sonet config -txCrc sonetCrc16
# Set the parameters
if [sonet set $chas $card 1] {
ixPuts "Sonet set failed on $chas.$card.1"
return 1
}
ixWriteConfigToHardware portList
# Let go of the ports that we reserved
ixClearOwnership $portList
# Disconnect from the chassis we're using
ixDisconnectFromChassis $host
# If we're running on UNIX, disconnect from the TCL Server
if [isUNIX] {
ixDisconnectTclServer $host
}