atmStat
atmStat - access VPI/VCI specific statistics.
SYNOPSIS
atmStat sub-command options
DESCRIPTION
The atmStat command is used to access statistics for particular VPI/VCI streams. VPI/VCIs for particular ports are added to a receive or transmit list with the addRx and addTx sub-commands. The statistics for all ports and VPI/VCIs in the lists is retrieved from the ports with the get sub-command. Individual statistics or rate statistics are accessed through the use of the getStat and getRate commands. The statistics are available in the STANDARD OPTIONS.
STANDARD OPTIONS
rxAal5CrcErrors
Read-only. 64-bit value. The number/rate of received CRC errors.
rxAal5Frames
Read-only. 64-bit value. The number/rate of received CRC errors.
rxAal5LengthErrors
Read-only. 64-bit value. The number/rate of received length errors.
rxAal5TimeoutErrors
Read-only. 64-bit value. The number/rate of received timeout errors.
rxAtmCells
Read-only. 64-bit value. The number/rate of received ATM cells.
txAal5Bytes
Read-only. 64-bit value. The number/rate of transmitted AAL bytes.
txAal5Frames
Read-only. 64-bit value. The number/rate of transmitted AAL frames.
txAal5ScheduledBytes
Read-only. 64-bit value. The number/rate of transmitted AAL bytes, not including idle cells.
txAal5ScheduleFrames
Read-only. 64-bit value. The number/rate of transmitted AAL frames, not including idle cells.
txAtmCells
Read-only. 64-bit value. The number/rate of received ATM cells.
vci
Read-only. The current VCI.
vpi
Read-only. The current VPI.
COMMANDS
The atmStat command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
atmStat addRx chasID cardID portID vpi vci
Adds the VPI/VCI for the indicated port to the receive list. If the 5-tuple is not in the current reassembly list (atmReassembly), then it is automatically added to the list with the default encapsulation (atmLlcSnapRoutedProtocol). The encapsulation is only used for ports in packet group mode to correctly identify the packet group ID. Receive ports with other than default encapsulation should first be added by atmReassembly and then added with this sub-command. Specific errors include:
- Invalid port
- VPI/VCI already exists
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- The maximum number of Rx stats has been exceeded
atmStat addTx chasID cardID portID vpi vci
Adds the VPI/VCI for the indicated port to the transmit list. Specific errors include:
- Invalid port
- VPI/VCI already exists
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- The maximum number of Tx stats has been exceeded
atmStat cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the atmStat command.
atmStat config option value
Modify the configuration options of the atmStat. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for atmStat.
atmStat delRx chasID cardID portID vpi vci
Removes the VPI/VCI for the indicated port from the receive list. The 5-tuple is not removed from the current reassembly list (atmReassembly). Specific errors include:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- Invalid VPI/VCI
- The item is not in the receive list
atmStat delTx chasID cardID portID vpi vci
Removes the VPI/VCI for the indicated port from the transmit list. Specific errors include:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- Invalid VPI/VCI
- The item is not in the transmit list
atmStat get
Gets the statistics for all of the VCI/VPIs added to the command using addTx and addRx. Specific errors are:
- Invalid port
- The port is in use by another user
- No connection to a chassis
- ATM is not supported on this port
atmStat getFirstRxPair chasID cardID portID
Accesses the first VPI/VCI pair in the receive list, whose values can be found in the STANDARD OPTIONS for this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- No pairs in the list.
atmStat getFirstTxPair chasID cardID portID
Accesses the first VPI/VCI pair in the transmit list, whose values can be found in the STANDARD OPTIONS for this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- No pairs in the list.
atmStat getNextRxPair chasID cardID portID
Accesses the next VPI/VCI pair in the receive list, whose values can be found in the STANDARD OPTIONS for this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- No more pairs in the list.
atmStat getNextTxPair chasID cardID portID
Accesses the next VPI/VCI pair in the transmit list, whose values can be found in the STANDARD OPTIONS for this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
- No more pairs in the list.
atmStat getRate chasID cardID portID vpi vci
Makes all of the rate statistics for the particular VPI/VCI on the port available through the STANDARD OPTIONS of this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- The VPI/VCI pair is not included in either the receive or transmit list
- ATM is not supported on this port
atmStat getStat chasID cardID portID vpi vci
Makes all of the statistics for the particular VPI/VCI on the port available through the STANDARD OPTIONS of this command. Specific errors are:
- The port is in use by another user
- No chassis connection
- The VPI/VCI pair is not included in either the receive or transmit list
- ATM is not supported on this port
atmStat removeAllRx chasID cardID portID
Removes all the VPI/VCI for the indicated port from the receive list. Specific errors include:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
atmStat removeAllTx chasID cardID portID
Removes all the VPI/VCI for the indicated port from the transmit list. Specific errors include:
- The port is in use by another user
- No chassis connection
- ATM is not supported on this port
- Invalid port
atmStat set Default
Sets to IxTclHal default values for all configuration options.
EXAMPLES
package require IxTclHal
set chassis 1
set card 42
set vpi 1
set vci 17
# Remove all TX and RX ports for port
atmStat removeAllRx $chassis $card 1
atmStat removeAllTx $chassis $card 1
atmStat removeAllRx $chassis $card 2
atmStat removeAllTx $chassis $card 2
# Add both ports to both lists
if [atmStat addRx $chassis $card 1 $vpi $vci] {
ixPuts "Error in atmStat addRx"
}
if [atmStat addRx $chassis $card 2 $vpi $vci] {
ixPuts "Error in atmStat addRx"
}
if [atmStat addTx $chassis $card 1 $vpi $vci] {
ixPuts "Error in atmStat addTx"
}
if [atmStat addTx $chassis $card 2 $vpi $vci] {
ixPuts "Error in atmStat addTx"
}
# .... run some traffic ...
# Get the statistics data for all the ports and VPI/VCI
if [atmStat get] {
ixPuts "Error in atmStat get"
}
after 2000
if [atmStat getStat $chassis $card 1 $vpi $vci] {
ixPuts "Error in atmStat getStat"
}
ixPuts "Port 1: [atmStat get -txAtmCells] cells transmitted, \
[atmStat get -rxAtmCells] received"
if [atmStat getRate $chassis $card 2 $vpi $vci] {
ixPuts "Error in atmStat getStat"
}
ixPuts "Port 2: [atmStat get -txAtmCells] cells transmitted/sec, \
[atmStat get -rxAtmCells] received/sec"