sonetOverhead
sonetOverhead - insert J0/J1 overhead trace messages.
SYNOPSIS
sonetOverhead sub-command options
DESCRIPTION
The sonetOverhead command is used to configure the insertion of trace messages in the J0/J1 areas of the sonet overhead. The sonetOverhead configurations for circuit are grouped under the sonetCircuitProperties. command.
STANDARD OPTIONS
enableJ0Insertion
true | false
If true, the message in traceMessageJ0 is inserted in the sonet header. (default = false)
enableJ1Insertion
true | false
If true, the message in traceMessageJ1 is inserted in the sonet header. (default = false)
traceMessageJ0
The value of the trace message to insert in the J0 bytes of the sonet header, if enableJ0Insertion is set to true. The value is expressed as a hex string. After a sonetOverhead get, this holds the value of the J0 bytes from the received sonet header. (default = {})
traceMessageJ1
The value of the trace message to insert in the J1 bytes of the sonet header, if enableJ1Insertion is set to true. The value is expressed as a hex string. After a sonetOverhead get, this holds the value of the J1 bytes from the received sonet header. (default = {})
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.
sonetOverhead 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.
sonetOverhead 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.
sonetOverhead get chasID cardID portID [circuitID] [timeslot]
Gets the current sonetOverhead trace messages for the port indicated 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
- The port is not a Packet over Sonet port.
sonetOverhead set chasID cardID portID [circuitID] [timeslot]
Sets the configuration of the indicated port 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.
sonetOverhead setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
package req IxTclHal
set hostname astro
set txCard 2
set rxCard 3
set port 1
set streamId 1
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 chassis [ixGetChassisID $host]
set portList [list [list $chassis $txCard $port] [list $chassis $rxCard $port]]
# 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
}
# port setup
# sonet setup
sonetOverhead setDefault
sonetOverhead config -enableJ0Insertion true
sonetOverhead config -enableJ1Insertion true
sonetOverhead config -traceMessageJ0 {F8 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00}
sonetOverhead config -traceMessageJ1 {E8 65 6C 6C 6F 20 74 68 65 72 65 20 00 00 00 00}
sonetOverhead set $chassis $txCard $port
ixWritePortsToHardware portList
sonetOverhead get $chassis $rxCard $port
set j0 [sonetOverhead cget -traceMessageJ0]
set j1 [sonetOverhead cget -traceMessageJ1]
# 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
}