Chassis, Cards and Ports

These commands included in this section are related to the setup of tests, before any data is applied. As discussed in the Ixia Reference Guide, Ixia equipment is organized as a chain of individual chassis connected by Sync-In/Sync-Out wires. The chassisChain command is used to hold information about the chain as a whole. One copy should be instantiated for the lifetime of the program. The chassis command is used to define and add chassis to the chain. Each chassis has two very important options: id, which is referenced elsewhere in referring to all levels of hardware, and name, which is the IP hostname/address used to communicate with the hardware. chassisChain sub-command broadcastTopology should be called after all the chassis have been added to the chain. Although each individual chassis, card and port has an individual write method, ixWriteConfigToHardware is a convenient means of writing to all chassis, in synchronization.

With the advent of the IXIA 100, the means by which geographically distributed chassis chains may be synchronized has been expanded. This is controlled by the timeServer command.

Cards reside within chassis and the card command is provided to access several read-only version variables for the card.

Ports are the principal focus of setup programming in the TCL API. All of the port’s characteristics are visible and changeable through port and its associated commands.

The following commands are included in this section:

session

session is an optional command used to control sharing of ports on one or more chassis. It should be used where there is any possibility of multiple users sharing chassis. session -login is used to log-in and portGroup -setCommand is used to take ownership of ports.

The important options and sub-commands of this command are listed in the table below.

Table:session Options

Member Usage

userName

The user's name after login.

captureBuffer

SegmentSize

Sets the capture buffer request size in MB.

Table:session Sub-Commands

Member Usage

login

Logs a user in for purposes of ownership.

logout

Logs out the current user.

version

version provides access to assorted pieces of version information for the Tcl software. Note that on Unix systems, a connection to the chassis must have occurred before version information is available. version for full details and ixConnectToChassis for connection information.

chassisChain

A single instance of this command should be instantiated and not destroyed for the entirety of the test process. It is the container that holds all of the individual chassis designations and their connections. See the Ixia Reference Guide for a discussion of chassis chains. chassisChain for full details.

The important options and sub-commands of this command are listed in the table below.

Table:chassisChain Options

Member Usage

startTime

The delay time before port transmit starts.

Table:chassisChain Sub-Commands

Member Usage

broadcastTopology

Must be called after the last chassis has been added with chassis.add.

timeServer

The timeServer command handles the means by which chassis chains are coordinated. See the Ixia Reference Guide for a discussion of timing sources. Refer to timeServer for details. A chassis chain may use any of the following time sources:

The important options and sub-commands of this class are listed in the table below.

Table:timeServer Command Options

Member Usage

timeSource

The choice of time source.

sntpClient

For the SNTP choice, the location of the SNTP server.

antennaStatus

For the GPS unit, the antenna's connection status.

gpsStatus

For the GPS unit, the locked/unlocked status of the GPS.

gpsTime

For the GPS unit, the GPS read time, in seconds.

pllStatus

For the GPS unit, the status of the phased locked loop that is driven by the GPS.

qualityStatus

For the GPS unit, the quality of the received GPS signal.

state

For the GPS unit, the current state of the GPS.

chassis

chassis is used in the definition of a chassis and addition of the chassis to the chassis chain. See the Ixia Reference Guide for a discussion of chassis. chassis for full details.

The important options and sub-commands of this command are mentioned in the following table:

Table:chassis Options

Member Usage

id

The identification number given to the chassis. This is used in most commands to associate with ports.

name

This is the IP hostname or IP address of the chassis, which is used to actually communicate with the chassis. Use 'localhost' if you are running your TCL application on the chassis itself.

sequence

The sequence of a chassis in a chain.

Table:chassis Sub-Commands

Member Usage

add

Adds a new chassis to the chain.

export

Writes a data file with all card and port configurations to a file which may be used with the import command.

import

Reads and installs a previously written file from the export sub-command.

card

The card command retrieves several card characteristics. See the Ixia Reference Guide for a discussion of load modules. Refer to card for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:card Options

Member Usage

fpgaVersion

The FPGA version on the card.

hwVersion

The card's hardware version.

portCount

The number of ports on the card.

type

The type of the card.

typeName

The name of the type of card.

serialNumber

The serial number of the card.

appsId

The application ID.

Table:card Sub-Commands

Member Usage

write

Card specific properties are written to the card, without any stream or port properties.

port

The port command controls the basic aspects of port setup. Some port and protocol specific attributes are included in this command, while other aspects are covered by additional commands in this section. See the Ixia Hardware & Reference Guide for a discussion of port hardware characteristics.

Specifically, the following port types have the indicated additional commands that may be used to control additional port features:

Note that the elements options DestMacAddress, MacAddress and numAddresses are stored as convenience for use by other sub-commands. Do not destroy the port instance until you are completely done with the port. port for full details.

The important options and sub-commands of this command are mentioned in the following table:

Table:port Options

Category Member Usage

Basic

name

The name associated with the port.

 

owner

The name of the owner of the port.

 

type

(Read-only) The type of the Ixia port. Both speeds and interface types are described.

 

loopback

Controls whether the port is in loopback mode or not.

 

flowControl

Enables flow control on the port.

 

linkState

(Read-only) The current state of the link with the DUT.

 

portMode

For ports that support multi-mode operation, the current operational mode.

Transmit

transmitMode

Controls the following basic transmission mode of the port:

  • Packet stream
  • Packet flow
  • TCP Round Trip
  • Advanced Scheduler
  • Bit Error Rate Testing (BERT)

Mix of SONET DCC and SPE traffic.

 

enableRepeatableLast-

RandomPattern

lastRandomSeedValue

For ports that the support repeatable random feature, this allows streams that used random values to repeat their values again.

 

transmitClockDeviation

For ports that support the frequency offset feature, a transmit frequency deviation.

 

preEmphasis

For ports that support pre-emphasis, a percentage pre-emphasis value.

Receive

receiveMode

Controls the following basic receive mode of the port:

  • Capture
  • PacketGroup
  • TCP Round Trips
  • Data Integrity
  • First Time Stamp
  • Sequence Checking
  • Bit Error Rate Testing (BERT)
  • SONET DCC
  • Wide packet group
  • PRBS packets

Addressing

DestMacAddress

The destination MAC address. Note that port holds this and the next two values as a convenience only for use in other commands. Do not destroy the port instance until you are done using the port.

 

MacAddress

The first source MAC address.

 

numAddresses

The number of source addresses assigned to the port.

Flows

usePacketFlowImageFile

Controls whether the port is used in stream mode or flow mode. If set to flow mode, then the packetFlowFileName member should be set.

 

packetFlowFileName

The name of the file containing the packet flow information.

Pause Control

directedAddress

The address the port listens to for a directed pause message.

 

multicastPauseAddress

The address the port listens to for a multicast pause message.

For:

10/100 Ports

autonegotiate

Sets auto-negotiate mode for the port.

 

duplex

Controls half / full duplex mode for the port.

 

advertise100FullDuplex

advertise100HalfDuplex

advertise10FullDuplex

advertise10HalflDuplex

These four elements control what speeds and duplex are advertised during autonegotiation.

 

speed

10 or 100 Mbps.

For:

Gigabit Ports

rxTxMode

Basic mode for the port are the following:

  • Normal
  • Loopback
  • Simulate cable disconnect

 

aremovedvertise1000FullDuplex

Controls whether gigabit full duplex is advertised during auto negotiation.

 

advertiseAbilities

Sets the following type elements advertised during negotiation:

  • None
  • Send only
  • Send and Receive
  • Send and/or Receive

 

ignoreLink

Causes the port to ignore the link.

 

negotiateMasterSlave

Indicates whether master/slave mode should be negotiated.

 

masterSlave

If master/slave mode is being negotiated, then this is the indicates the ports desire (master or slave). Otherwise this is the value associated with the link.

 

timeoutEnable

Enables autonegotiation timeout.

For:

POS Ports

rxCrc

Indicates whether a 16 or 32 bit CRC is to be used on the receive side of the port.

 

txCrc

Indicates whether a 16 or 32 bit CRC is to be used on the transmit side of the port.

Table:port Sub-Commands

Member Usage

getFeature

Determines whether a specific feature is present in the featureList for the port.

isValidFeature

Determines if a port feature is available for the port.

isActiveFeature

Determines whether a port is currently configured correctly to use a feature.

reset

Deletes all streams from a port. Current configuration is not affected. Note: In order for port reset to take effect, stream write or ixWriteConfigToHardware commands should be used to commit the changes to hardware.

setDefault

Sets the port to default values.

setFactoryDefaults

Sets a consistent set of default values for the port type. The port mode for dual PHY ports is reset to the default.

setModeDefaults

Sets a consistent set of default values for the port type and the current mode of the port. The mode of the port is not affected.

setParam

Operates as in config, but sets a single option.

setPhyMode

For dual PHY ports, which may operate over copper, fiber, or SGMII, this command allows the mode to be selected.

Note: The setDefault sub-command sets all options at default values, as indicated in port. These values are a consistent setting for 10/100 ethernet cards and may or may not be appropriate for other cards. In general, the sequence:

port setDefault
port set $chassis $card $port

fails.
The setFactoryDefaults sub-command, which relates to a particular port, sets all options at default values appropriate for the type of port. The sequence:

port setFactoryDefaults $chassis $card $port
port set $chassis $card $port

always succeed. For multi-type boards, for example, OC192/10GE WAN, the board type is forced to one particular setting and may not be appropriate.
The setModeDefaults sub-command, however, leaves the mode of multi-type boards while performing the same operation as setFactoryDefaults.

MII

The MII commands are available for 10/100 MII and 10GE XAUI/XGMII ports only. The following commands are included in this set:

mii

mii for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:mii Options

Member Usage

enableManualAuto

Negotiate

If set, causes the port to auto-negotiate when the MII registers are written

miiRegister

The MII register number to read/write.

phyAddress

Physical address of the MII register location. -1 for the default.

readWrite

The read/write properties of the register are as following:

  • Disabled
  • Read-Only
  • Read-Write

registerValue

The value of the selected register.

Table:mii Sub-Commands

Member Usage

get

This method should be called first, before any cget operations. The register number indicated in miiRegister is read into readWrite and registerValue.

selectRegister

After get is used, this method allows a different register (as indexed by miiRegister) to be made available in readWrite and registerValue.

set

Sets the values from readWrite and registerValue to be written to the MII register indexed by miiRegister.

write

Sends all modified MII registers to the hardware.

miiae

miiae for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:miiae Options

Member Usage

phyAddress

Physical address of the MII register location.

Table:miiae Sub-Commands

Member Usage

clearAllDevices

Removes all associated devices from the MII.

addDevice

Adds a device defined in the mmd command to the MII.

delDevice

Removes a single MMD from the MII.

getDevice

Retrieves the information about a single MMD in the MII. The data about the device is available through the use of the mmd and mmdRegister commands.

set

Sets the devices associated with one of the three supported PHYs: Internal, External1, or External2.

get

Gets the devices associated with one of the three supported PHYs: Internal, External1, or External2.

mmd

mmd for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:mmd Options

Member Usage

address

Address of the MMD device within its associated MII.

name

Arbitrary name of the MMD device.

Table:mmd Sub-Commands

Member Usage

clearAllRegisters

Removes all associated registers from the MMD device.

addRegister

Adds a register defined in the mmdRegister command to the MMD.

delRegister

Removes a single register from the MMD.

getRegister

Retrieves the information about a single register in the MMD. This must have been preceded by an miiae getRegister command. The data about the device is available through the use of the mmdRegister command.

mmdRegister

mmdRegister for full details. The important options of this command are:

Table:mmdRegister Options

Member Usage

address

Address of the register location.

name

Arbitrary name of the register.

readWrite

The read/write properties of the register:

  • Disabled
  • Read-Only
  • Read-Write

registerValue

The value of the selected register.

xaui

xaui for full details.

The important options of this command are:

Table:xaui Options

Member Usage

clockType

Determines whether to use an internal or external clock.

podPower

Determines whether 5V power is to be applied to the at pin 4.

userPower

Determines whether 5V power is to be applied to the at pin 5.

Packet over Sonet

The next set of commands allow for the setting of all PoS specific values. If the default values associated with a task are correct, then the corresponding command need not be used. See the Ixia Reference Guide for a discussion of SONET/POS load module characteristics.

sonet

See the Ixia Reference Guide for a general discussion. sonet for full details. The important options of this command are:

Table:sonet Options

Category Member Usage

Header

header

Sets the type of PoS header:

Interface

interfaceType

Sets the type and speed of the sonet interface:

  • OC3, OC12 or OC48.
  • STM1c, STM4c or STM16c.

Transmit

dataScrambling

Controls data scrambling in the sonet framer.

 

lineScrambling

Controls line scrambling in the sonet framer.

CRC

rxCrc

Sets the receive CRC mode: 16 or 32 bit mode.

 

txCrc

Sets the transmit CRC mode: 16 or 32 bit mode.

APS

apsType

Sets the Automatic Protection Switching mode to linear or ring topology.

 

customK1K2

Enables or disables customer K1K2 bytes.

 

k1NewState

Allows the K1 byte code value to be sent in the Sonet frame.

 

k2NewState

Allows the K2 byte code value to be sent in the Sonet frame.

Path Signal

C2byteExpected

The received path signal label.

 

C2byteTransmit

The path signal label to be transmitted.

Error Handling

lineErrorHandling

Enables line error handling.

 

pathErrorHandling

Enables path error handling.

 

Note: The setDefault sub-command sets all options at default values, as indicated in sonet. 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.

sonetError

This command allows the parameters associated with a variety of simulated SONET errors to be programmed. The errors that are programmed may be inserted once, periodically or continuously. See the Ixia Reference Guide for a general discussion. sonetError for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:sonetError Options

Member Usage

insertionMode

Controls whether an individual error is inserted periodically or continuously.

errorPeriod

errorUnits

The frequency with which periodic errors are inserted, which may be expressed in seconds or frames.

consecutiveErrors

The number of consecutive errors to be inserted at a time.

Table:sonetError Sub-Commands

Member Usage

setError

Parameters associated with a particular error type are set in IxHal. A set command is needed to get these values into the hardware.

getError

Reads back the values associated with a particular error type into the options described above.

start

stop

Starts and stops periodic/continuous error insertion as programmed.

insertError

Inserts a particular error for a single instance. setError and set must be used before this command.

sonetOverhead

This command allows the J0/J1 values of the Sonet overhead to be programmed and read back. sonetOverhead for full details. The important options of this command are mentioned in the following table:

Table:sonetOverhead Options

Member Usage

enableJ0Insertion

Enable the insertion of J0 trace messages.

enableJ1Insertion

Enable the insertion of J1 trace messages.

traceMessageJ0

The J0 trace message, as a hex string.

traceMessageJ1

The J1 trace message, as a hex string.

dcc

This command allows the selection of the DCC byte placement and CRC type. See the Ixia Reference Guide for a general discussion.dcc for full details. The important options of this command are mentioned in the following table:

Table:dcc Options

Member Usage

crc

The type of CRC used in the DCC stream

overheadBytes

The placement of the DCC bytes in the line or section overhead bytes.

timeFill

The time fill byte to be used.

RPR

Ixia’s Resilient Packet Ring (RPR) implementation is available on selected POS load modules. RPR is a proposed industry standard for MAC Control on Metropolitan Area Networks (MANs) and is defined in IEEE P802.17/D2.1. RPR networks consist of two counter rotating ringlets, with nodes called stations support MAC clients that exchange data and control information with remote peers on the ring. Up to 255 stations can be supported by RPR networks.

RPR is enabled on a port by selecting the appropriate SONET header encapsulation in the sonet command:

sonet config -header sonetRpr

Once enabled, RPR Fairness packets may be set up and transmitted on a regular basis using the rprFairness command.

For all other RPR messages and encapsulated packets, the rprRingControl command should be used set up the RPR header.

All IP and ARP packets are automatically encapsulated after the SONET header has been set to RPR. Three commands are used to provide RPR topology discovery, protection and other maintenance:

All three message types are added to a stream using their respective set sub-commands. A stream set command then makes them ready for transmission.

rprRingControl

The rprRingControl command is used to set up the content of RPR header used by all RPR packets, except the RPR Fairness Frames, which are set up in the rprFairness command. The options are divided into Base Control and Extended Control options. rprRingControl for full details. The important options of this command are mentioned in the following table:

Table:rprRingControl Options

Type Option Usage

Base

packetType

Indicates whether the RPR packet is an idle, control, fairness or data frame.

 

ringIdentifier

Which ringlet the packet should be transmitted on.

 

serviceClass

The class of service that the packet belongs to.

 

ttl

The time-to-live for the RPR packet.

 

enableFairnessEligible

Whether the packet is eligible for throttling in the fairness algorithm.

 

enableOddParity

parityBit

Controls parity for Fairness frames.

 

enableWrapEnable

Whether the packet is eligible for wrapping in the case of a failure.

Extended

extendedFrame

Indicates that the frame was sent from and to MAC addresses that are not stations. The other fields are then provided as part of the frame.

 

ttlBase

The TTL of the original packet prior to encapsulation.

 

floodingForm

Whether the frame should be flooded or not and if so to which ringlets.

 

strictOrder

Whether strict ordering on packets should be preserved.

 

passedSource

Indicates that a wrapped packet has passed its source.

rprFairness

The rprFairness command is used to set up the content of RPR Fairness messages sent periodically from a node. The RPR Fairness Algorithm (FA) is used to manage congestion on the ringlets in an RPR network. Fairness frames are sent periodically to advertise bandwidth usage parameters to other nodes in the network to maintain weighted fair share distribution of bandwidth. The messages are sent in the direction opposite to the data flow; that is, on the other ringlet.rprFairness for full details. The important options of this command are mentioned in the following table:

Table:rprFairness Options

Member Usage

<ring control>

The rprFairness command maintains a separate copy of the Base options discussed in rprRingControl. See that section for details.

enableTransmit

Enables the transmission of RPR Fairness messages.

controlValue

The normalized advertised fair rate value.

messageType

Specifies single or multi-point choke message.

repeatInterval

The frequency of fairness message transmission.

rxAgingInterval

A timeout value for receipt of Fairness messages from other nodes.

rxMacAddress

txMaxAddress

The receive and transmit MAC addresses to use in Fairness messages.

rprProtection

The rprProtection command is used to build RPR protection messages. Protection messages provide wrapping status information and indicates of a station’s desires with respect to wrapping. rprProtection for full details. The important options of this command are mentioned in the following table:

Table:rprProtection Options

Member Usage

wrapPreferred

A station's ability and/or preference to support wrapping.

jumboPreferred

A station's ability and/or preference to support jumbo frames.

protectionRequestEast

protectionRequestWest

The protection state of the East/West interface.

sequenceNumber

Use to ensure proper interpretation of Protection messages.

wrappingStatusEast

wrappingStatusWest

The wrapping status for traffic received on the East/West interface.

rprOam

The rprOam command is used to build RPR OAM (Operations, Administration, Management) messages. These messages are sent between stations to determine the operational status of the connection. Following are the types of messages:

rprOam for full details. The important options of this command are mentioned in the following table:

Table:rprOam Options

Member Usage

typeCode

Indicates the type of message: flush, echo request, echo response, or vendor specific.

requestProtectionMode

The requested protection mode for the station.

requestRinglet

Controls which ringlet the receiving station should respond on.

responseProtectionMode

As in requestProtectionMode, but for a response.

responseRinglet

As in requestRinglet, but for a response.

vendorOui

For a vendor specific message, the vendor's OUI designation. The user data for the message should be established using stream background data.

rprTopology

The rprTopology command is used to build RPR topology messages. RPR topology messages consist of a set of TLV (type-length-value) settings constructed through the use of the rprTlvIndividualBandwidth and rprTlvBandwidthPair, rprTlvWeight, rprTlvTotalBandwidth, rprTlvNeighborAddress, rprTlvStationName, and rprTlvVendorSpecific commands, followed by a call to the addTlv command for that type.

A TLV is added to a topology message by configuring the TLV with the appropriate command from the list above and then adding it to the topology message with rprTopology addTlv type, where type indicates which of the TLVs to use. A TLV may be retrieved from a topology message through the use of getFirstTlv / getNextTlv. These commands return the name/pointer of the command that was used to configure the TLV. This is typically used in the following sequence of commands:

set tlvCmd [rprTopology getFirstTlv]

$tlvCmd config ...

Each of the TLV commands also has a type option which uniquely identifies the type of the TLV.

The individual TLVs are set up using the commands in the following sections. rprTopology for full details. The important sub-commands of this command are mentioned in the following table:

Table:rprTopology Sub-Commands

Member Usage

addTlv

Adds a TLV to the list associated with the Topology message.

clearAllTlvs

Removes all TLVs in the list.

getFirstTlv

getNextTlv

Cycles through the list of TLVs.

delTlv

Deletes the currently addressed TLV.

rprTlvIndividualBandwidth and rprTlvBandwidthPair

The rprTlvIndividualBandwidth command is used to set up the content of an RPR Individual Bandwidth TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprIndividualBandwidth command.

This command’s data is constructed by adding rprTlvBandwidthPairs. Bandwidth pairs are constructed through the use of the rprTlvBandwidthPair command and then added to this command with the rprTlvIndividualBandwidth addBandwidthPair command. Each bandwidth pair corresponds to the reserved bandwidth between this node and a node a number of hops away from this node. The first item in the pair represents the reserved bandwidth on ringlet 0 and the second represents the reserved bandwidth on ringlet 1.

Bandwidth pairs must be added in order; that is, the node one hop away, followed by the node two hops away, etc.

rprTlvIndividualBandwidth and rprTlvBandwidthPair for full details. The important sub-commands of the rprTlvIndividualBandwidth command are:

Table:rprTlvIndividualBandwidth Sub-Commands

Member Usage

addBandwidthPair

Adds a TLV to the list associated with the Topology message.

clearAllBandwidthPairs

Removes all TLVs in the list.

getFirstBandwidthPair

getNextBandwidthPair

Cycles through the list of TLVs.

delBandwidthPair

Deletes the currently addressed TLV.

The important options of the rprTlvBandwidthPair command are mentioned in the following table:

Table:rprTlvBandwidthPair Options

Member Usage

bandwidth0

bandwidth1

The bandwidth requirements of the two ringlets.

rprTlvWeight

The rprTlvWeight command is used to set up the content of an RPR Weight TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprWeight command. rprTlvWeight for full details. The important options of the this command are mentioned in the following table:

Table:rprTlvWeight Options

Member Usage

weightRinglet0

weightRinglet1

The weight values of the two ringlets.

rprTlvTotalBandwidth

The rprTlvTotalBandwidth command is used to set up the content of an RPR Total Bandwidth TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprTotalBandwidth command. rprTlvTotalBandwidth for full details. The important options of the this command are:

Table:rprTlvTotalBandwidth Options

Member Usage

bandwidthRinglet0

bandwidthRinglet1

The total reserved class A0 bandwidth value of the two ringlets.

rprTlvNeighborAddress

The rprTlvNeighborAddress command is used to set up the content of an RPR Neighbor Address TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprNeighborAddress command. rprTlvNeighborAddress for full details. The important options of the this command are mentioned in the following table:

Table:rprTlvNeighborAddress Options

Member Usage

neighborMacEast

neighborMacWest

The total reserved class A0 bandwidth value of the two ringlets.

rprTlvStationName

The rprTlvStationName command is used to set up the content of an RPR Station Name TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprStationName command. rprTlvStationName for full details. The important options of the this command are mentioned in the following table:

Table:rprTlvStationName Options

Member Usage

stationName

The name of the station.

rprTlvVendorSpecific

The rprTlvVendorSpecific command is used to set up the content of an RPR Vendor Specific TLV for use in an RPR topology message. This TLV is added to a topology message by use of the rprTopology addTlv rprVendorSpecific command. rprTlvVendorSpecific for full details. The important options of the this command are mentioned in the following table:

Table:rprTlvVendorSpecific Options

Member Usage

companyId

The IEEE/RAC company identifier.

dependentId

The company dependent part of the identifier.

vendorData

The vendor specific data associated with the topology message.

GFP

The Generic Framing Protocol is only available for certain ports, this may be tested through the use of the portisValidFeature... portFeatureGfp command. The GFP framing mode is enabled by setting the sonetheader option to sonetGfp. The GFP header and other options are set in the gfp and gfpOverhead commands. The filter and filterPallette commands have access to GFP HEC and CRC error conditions. Additional GFP specific statistics are available in the stat command.

gfp

The gfp command is used to set all GFP framing parameters. The important options of the this command are mentioned in the following table:

Table:gfp Options

Member Usage

enablePli

pli

Set the payload length indicator.

payloadType

Indicates the type of payload that is encapsulated.

fcs

The type of FCS to include.

channelId

The channel ID for management packets.

coreHecErrors

typeHecErrors

extensionHecErrors

Controls the inclusion of HEC errors in packets.

gfpOverhead

The gfpOverhead command is used to set several operation parameters. The important options of the this command are mentioned in the following table:

Table:gfpOverhead Options

Member Usage

enablePayloadScrambling

Enables payload scrambling.

enableSingleBitErrorCorrection

Enables single bit error correction.

deltaSyncState

Controls state machine transitions.

ppp and pppStatus

ppp allows for programming of the Point to Point protocol header, while pppStatus can be used to retrieve the current status and values of the PPP negotiation. The options of the two objects are integrated together in the next table. Items from pppStatus are indicated in underline mode. See the Ixia Reference Guide for a general discussion. ppp and pppStatus for full details. The important options of this command are mentioned in the following table:

Table:ppp/pppStatus Options

Category Member Usage

Basic

enable

Enables ppp negotiation.

Negotiation

activeNegotiation

Enables the active negotiation process.

 

enableAccmNegotiation

Enables asynchronous control character negotiation.

 

enableIp

Enables IP address negotiation

 

enableIpV6

Enables IPV6 address negotiation

 

enableLqm

Enables line quality monitoring negotiation.

 

enableOsi

Enable OSI over PPP negotiation

 

enableMpls

Enable MPLS over PPP negotiation

IP Addresses

ipState

The current state of IPCP negotiation

 

localIpAddress

The local port’s IP address.

 

peerIpAddress

The peer’s IP address.

IPv6 Interface ID

localIpV6IdType

localIpV6Negotiation

Mode

The negotiation mode and options.

 

ipV6State

The current state of IPV6 CP negotiation

 

localIpV6Iid

Suggested IPV6 address to be used for the Interface ID.

 

localIpV6MacBasedIid

Suggested MAC address to be used for the Interface ID.

 

peerIpV6IdType

peerIpV6Negotiation

Mode

The negotiation mode and options.

 

peerIpV6Iid

Suggested IPV6 address to be used for the Interface ID.

 

peerIpV6MacBasedIid

Suggested MAC address to be used for the Interface ID.

Retries

configurationRetries

The number of configuration requests to try.

 

terminationRetries

The number of termination requests to try.

Magic Number

useMagicNumber

Enables the use of a magic number in the negotiation to discover looped back connections.

 

magicNumberNegotiated

The magic number negotiated between the peers.

 

useMagicNumberRx/Tx

Enable negotiation and use of the magic number in the receive direction/transmit direction.

 

rx/txMagicNumberStatus

The status and value of transmit and receive magic number negotiation.

Maximum Receive Unit

rxMaxReceiveUnit

Maximum frame size in the receive direction.

 

txMaxReceiveUnit

Maximum frame size in the transmit direction.

LQM

lqmReportInterval

The desired LQM interval to be used during LQM negotiation

 

lqmQualityState

The current state of the LQM negotiation

 

lqmReportIntervalRx/Tx

The negotiation LQM receive/transmit port interval

 

lqmReportPacketCounterRx/Tx

The number of LQM packets received/transmitted

OSI

rxAlignment

txAlignment

The desired byte alignment for reception/transmission used during negotiation

 

osiState

The current state of OSI negotiation

 

rxAlignment

txAlignment

The negotiated byte alignment for reception/transmission

MPLS

mplsState

The current state of MPLS negotiation

hdlc

hdlc sets the three values associated with the HDLC header. See the Ixia Reference Guide for a general discussion."hdlc" for full details. The options and sub-commands of this command are mentioned in the following table:

Table:hdlc Options

Member Usage

address

control

protocol

The one-byte address field, one-byte control field and two-byte protocol field.

Table:hdlc Sub-Commands

Member Usage

setCisco

Sets the header variables to the Cisco defaults in IxHal.

setppp

Sets the header variables to the ppp defaults in IxHal.

frameRelay

frameRelay controls Frame Relay specific parameters. sonet config -header must be configured for the correct Frame Relay headers first. See the Ixia Reference Guide for a general discussion.“frameRelay” for full details. The values set here are within the Frame Relay header. Note that streamget must be called before this command’s get sub-command. The important options of this command are mentioned in the following table:

Table:frameRelay Options

Member Usage

addressSize

The address length in the header.

becn

Sets the backward congestion notification bit.

commandResponse

Sets the command or response bit.

control

Sets the control information bit.

discardEligibleBit

Sets the discard eligible bit.

dlci

DLCI core indicator bit in the Frame Relay address field.

counterMode

repeateCount

maskSelect

Parameters used to vary the DLCI between frames.

dlciCoreValue

Frame Relay address field.

etherType

The ethernet type of protocol to use.

extensionAddress

0/1/2/3

Extension address bit 0/1/2/3.

fecn

Sets the forward congestion notification bit.

nlpid

The network layer identifier for the upper-layer protocol.

bert and bertErrorGeneration

The bert command configures a BERT capable port. The pattern which is transmitted and/or received is programmed. bertErrorGeneration is used to insert errors into a transmitted stream. Received errors are available through the use of the stat command. See the Ixia Reference Guide for a general discussion.

Some of the BERT capable cards support channelized BERT operation. Where available, a level parameter indicates which channel is to be controlled. For example, an OC192 channel can be channelized into 4 OC48 channels and each OC48 channel can be channelized into 4 OC12 channels. Each channel selection at each level is represented as a digit in a dot (‘.’) separated string notation. For example, the 2nd OC48’s 3rd OC12 channel is represented as 2.3. This is illustrated in Figure: Channelized Bert Label Usage.

Figure: Channelized Bert Label Usage

Note that the OC48 channels may be referred to and operated on using a final .0 digit, as in 3.0.

The important options of the bert command are mentioned in the following table:

Table:bert Options

Member Usage

txRxPatternMode

Couples the expected receive pattern with the transmitted, or leaves it independent

txPatternIndex

txUserPattern

enableInvertTxPattern

Determines the transmitted pattern from one of a set or pre-programmed patterns or a user supplied pattern. The pattern may be inverted or not.

rxPatternIndex

rxUserPattern

enableInvertRxPattern

If the receive pattern is independently programmed form the transmitted pattern, determines the expected receive pattern from one of a set or pre-programmed patterns or a user supplied pattern. The pattern may be inverted or not.

The important options and sub-commands of the bertErrorGeneration command are mentioned in the following table:

Table:bertErrorGeneration Options

Member Usage

errorBitRate

period

Determines the frequency, in bits, with which errors are inserted. The choice may be from a pre-programmed set or set to an arbitrary value.

burstCount

The number of errors inserted at a time.

burstWidth

The number of errors to insert at a time.

burstPeriod

The number of good bits between error insertions.

bitMask

A 32-bit mask indicating which bits within a 32-bit word are to be errored.

Table:bertErrorGeneration Sub-Commands

Member Usage

startContinuousError

Starts the continuous insertion of programmed errors.

stopContinuousError

Stops the continuous insertion of errors.

insertSingleError

Inserts a single instance of the programmed error.

channelize

Channelizes an OC48 channel down into four OC12 channels. A port must first have been set to channelized mode by setting the port command’s transmitMode setting to portTxModeBertChannelized.

isChannelized

Determines whether a level is channelized already.

unChannelize

Unchannelizes an OC48 channel.

bertUnframed

The bertUnframed command is used to configure line speed and other operational characteristics for an unframed BERT port. The important options of this command are mentioned in the following table:

Table:bertUnframed Options

Member Usage

dataRate

The data rate at which data is transmitted.

operation

The type of operation: Normal, diagnostic loopback, or line loopback.

ATM

The next set of commands relates to ATM type cards. See the Ixia Reference Guide for a general discussion. Note that different types of ATM encapsulation result in different length headers, as per Table:ATM Header Length as a function of Encapsulation.

Table:ATM Header Length as a function of Encapsulation

Encapsulation Header Length

LLC Snap Routed

8

LLC Bridged Ethernet / 802.3

10

LLC Bridged Ethernet / 802.3 No FCS

10

LLC Encapsulated PPP

6

VC Muxed PPP

2

VC Muxed Routed

0

VC Muxed Bridged Ethernet / 802.3

2

VC Muxed Bridged Ethernet / 802.3 No FCS

2

The data portion of the packet normally follows the header, except in the case of the two LLC Bridged Ethernet choices, where 12 octets of MAC address and 2 octets of Ethernet type follow the header. The offsets used in the dataIntegrity, filter, flexibleTimestamp, ip, ipV6Fragment, packetGroup, protocolOffset, qos, tableUdfColumn, tcp, udf, and udp is with respect to the beginning of the AAL5 packet and must be adjusted by hand to account for the header.

atmPort

atmPort for full details. The atmPort command is used to configure the basic operational characteristics for an ATM port. The important options of this command are mentioned in the following table:

Table:atmPort Options

Member Usage

interfaceType

Sets the port to UNI (user-network interface) or NNI (network-network interface).

enableCoset

Enables or disables the use of the Coset algorithm with the Header Error Control byte.

enablePattern

Matching

Enables or disables the use of the atmFilter command to control capture and statistics. Enabling this feature reduces the maximum number of VCCs that may be used from 16K to 12K.

fillerCell

Designates which of two types of cells is transmitted during idle periods:

  • Idle Cell (VPI/VCI = 0 and CLP = 1)
  • Unassigned Cell (VPI/VCI = 0 and CLP = 0)

packetDecodeMode

The mode in which to decode received packets: Frame or cell.

reassemblyTimeout

The period of time to wait for a cell on a channel.

sourceLocationId

The source location ID.

atmHeader

atmHeader for full details. The atmHeader command is used to configure the 5-byte ATM header inserted in packets within streams. Note that streamget must be called before this command’s get sub-command. The important options of this command are mentioned in the following table:

Table:atmHeader Options

Member Usage

vpi/vci

enableAutoVpiVci

Selection

Sets the Virtual Path Identifier (VPI) and Virtual Circuit Identifier (VCI) for the header. The enableAutoVpiVciSelection control sets these to 0/32.

genericFlowControl

The Generic Flow Control value, used for device control signalling.

enableCL

Controls the congestion loss bit of the payload type.

cellLossPriority

The cell’s priority, when cells must be dropped. A value of 0 has a higher priority than 1.

hecErrors

The number of bit errors to insert in the HEC byte.

encapsulation

The type of ATM encapsulation to be used.

aal5Error

Force the insertion of AAL5 errors.

enableCpcsLength

cpcsLength

Allows the CPCS PDU length to be set.

header

A read-only 5-byte header value, set from the other options.

atmHeaderCounter

atmHeaderCounter for full details. The atmHeaderCounter command is used to configure the counter parameters that allow the value of the ATM header’s VPI and VCI fields to vary. The VPI and VCI values are separately controlled using the same command. Following are the types of counters available:

The important options and sub-commands of this command are mentioned in the following table:

Table:atmHeaderCounter Options

Member Usage

type

The type of counter used: Fixed, counter, random, or table.

mode

repeatCount

step

If a counter type is used, then this indicates whether the counter counts up or down continuously or for a particular count. The step size is also specified.

maskselect

maskvalue

If the random type is used, this indicates which bits of the value are fixed and to what values.

dataItemList

If the table type is used, then this is the table of values to be used round-robin.

Table:atmHeaderCounter Sub-Commands

Member Usage

set

Sets the options for either the VPI or VCI value.

get

Gets the options for either the VPI or VCI value.

atmOam

The atmOam command is used to configure multiple ATM OAM messages to be transmitted on an ATM port. The basic parameters for all OAM messages are configured in the options of this command. Additional parameters that are particular to a specific OAM message are taken from the following additional commands:atmOamActDeact, atmOamAis, atmOamFaultManagementCC, atmOamFaultManagementLB or atmOamRdi.

Once configured, the OAM message for a VPI/VCI pair is added to the list associated with this command with the add sub-command. Transmission of the OAM messages is initiated with the start sub-command and stopped with the stop sub-command.

Trace information, if enabled with the enableTrace option is retrieved using the atmOamTrace command.

Refer to atmOam for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:atmOam Options

Member Usage

enableTx

Enable the use of this list element.

enableCC

Enable continuous checking.

enableLB

Enable loopback.

enableTrace

Enable collection of trace messages for the VPI/VCI.

functionType

The type of the OAM message.

endPointsType

The type of endpoints: Segment or end-to-end.

cellFlowType

The cell flow type: F4 or F5.

Table:atmOam Sub-Commands

Member Usage

select

Select the particular port to operate on.

add

Add an OAM message to the list for a particular VPI/VCI pair.

removeAll

del

Delete all or a particular list entry.

getFirstPair

getNextPair

Iterate through the list entries.

start

stop

Start and stop the transmission and reception of OAM messages.

atmOamActDeact

The atmOamActDeact command holds command specific options for the activation/deactivation message. Refer to “atmOamActDeact” for full details. The important options of this command are mentioned in the following table:

Table:atmOamActDeact Options

Member Usage

enableTxContinuous

txCount

Controls continuous or counted message transmission.

action

The direction of the action: One way or bi-directional.

correlationTag

The correlation tag.

defectLocation

The defect location.

messageId

The particular message: Activate/Deactivate Confirmed/Denied.

atmOamAis

The atmOamAis command holds command specific options for the AIS message. Refer to atmOamAis for full details. The important options of this command are mentioned in the following table:

Table:atmOamAis Options

Member Usage

enableTxContinuous

txCount

Controls continuous or counted message transmission.

atmOamFaultManagementCC

The atmOamFaultManagementCC command holds command specific options for the Fault Management Continuous Checking message. Refer to atmOamFaultManagementCC for full details. The important options of this command are mentioned in the following table:

Table:atmOamFaultManagementCC Options

Member Usage

enableTxContinuous

txCount

Controls continuous or counted message transmission.

atmOamFaultManagementLB

The atmOamFaultManagementLB command holds command specific options for the Fault Management Loopback message. Refer to atmOamFaultManagementLB for full details. The important options of this command are mentioned in the following table:

Table:atmOamFaultManagementLB Options

Member Usage

enableTxContinuous

txCount

Controls continuous or counted message transmission.

correlationTag

The correlation tag.

loopbackIndication

The loopback indication: Reply or request.

loopbackIndicationId

The loopback indication ID.

sourceLocationId

The source location ID.

atmOamRdi

The atmOamRDI command holds command specific options for the RDI message. Refer to atmOamRdi for full details. The important options of this command are mentioned in the following table:

Table:atmOamRdi Options

Member
  • Usage

enableTxContinuous

txCount

Controls continuous or counted message transmission.

defectLocation

The defect location.

atmOamTrace

The atmOamTrace command is used to retrieve ATM OAM messages. These are collected for any OAM message in which the enableTrace option was set to true when atmOam add was called.

Messages are collected into a circular buffer of maxNumTrace messages in size. Newest entries replace oldest entries as necessary. The get chassis card port sub-command is used to retrieve all of the message. The other get commands are used to look at particular entries.

Refer to atmOamTrace for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:atmOamTrace Options

Member Usage

maxNumTrace

The maximum number of traces to hold in the buffer.

numTrace

The number of traces in the buffer.

traceString

The entire trace message as a single string.

functionType

timeStamp

txRxType

vci

vpi

The components of the message.

Table:atmOamTrace Sub-Commands

Member Usage

get ch card port

Get the trace messages.

get index

Get a particular trace message.

clear

Clear the message buffer.

getFirst

getNext

Iterate through the messages.

Circuit

The following commands support the Virtual Concatenation feature for 2.5G and 10G MSM cards.

sonetCircuit

The sonetCircuit command holds all the circuits. Refer to sonetCircuit for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:sonetCircuit Options

Member Usage

txActiveTimeslot

List

Configure the active tx members. (default= "")

rxActiveTimeslot

List

Configure the active rx members. (default= "")

txIdleTimeslotList

Configure the idle tx members. (default= "")

rxIdleTimeslotList

 

name

Configure the circuit name. (default = "")

direction

Configure the direction.

(default = circuitBidirectionSymmetrical)

txType

Configure the tx payload speed. (default = circuitPayloadRateSTS1mv )

rxType

Configure the rx payload speed. (default = circuitPayloadRateSTS1mv )

enableTxLcas

Enable the Lcas on transmit side. (default = FALSE )

enableRxLcas

Enable the Lcas on receive side. (default = FALSE )

index

Read only.This parameter is used to view the circuit index assigned by hardware. (default = 0)

Table:sonetCircuit Sub-Commands

Member Usage

cget option

Returns the current value of the configuration option given by option.

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.

setDefault

Sets to IxTclHal default values for all configuration options.

sonetCircuitList

The sonetCircuitList command holds all the circuits. Refer to sonetCircuitList for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:sonetCircuitList Options

Member Usage

numCircuits

Read only. This parameter is used to display the number of existing circuits in the circuit list.

Table:sonetCircuitList Sub-Commands

Member Usage

add

Adds a new circuit and verifies that the circuit can be added.

cget option

Returns the current value of the configuration option given by option.

clearAllCircuits

Remove all the circuits from the Sonet circuit list.

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.

del circuitID

Deletes the circuit with the given ID.

get circuitID

Gets the existing circuit with the given circuit ID.

getFirst

Gets the first circuit from the Sonet circuit list.

getNext

Gets the next circuit from the Sonet circuit list.

select chasID cardID portID

Select the port where the IxTclHal configurations is set to local IxHal.

set circuitID

Modify the existing circuit with the given circuit ID.

setDefault

Sets to IxTclHal default values for all configuration options.

sonetCircuitProperties

The sonetCircuitProperties command is used to configure circuit properties after the circuit is added. The Sonet properties for the circuit is configured here.

Refer to sonetCircuitProperties for full details. The important options of this command are mentioned in the following table:

Table:sonetCircuitProperties Options

Member Usage

transmitMode

This parameter is used to configure the transmit mode. (default = circuitTxModePacketStreams)

payloadType

This parameter is used to configure the Sonet header payload type.

(default = sonetHdlcPppIp)

dataScrambling

This parameter is used to configure the Sonet dataScrambling payload type. (default = false)

C2byteTransmit

This parameter is used to configure the Sonet C2byteTransmit .

(default = 22)

C2byteExpected

This parameter is used to configure the Sonet C2byteExpected.

(default = 22)

rxCrc

Used to configure Rx CRC.

txCrc

Used to configure Rx CRC.

index

Read only. This parameter is used identify the circuit with associated ID.

Table:sonetCircuitProperties Sub-Commands

Member Usage

cget option

Returns the current value of the configuration option given by option.

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.

get chassis ID cardID portID circuitID

Gets the existing circuit properties with the given circuit ID.

set chassis ID cardID portID circuitID

Modify the existing circuit properties with the given circuit ID.

setDefault

Sets to IxTclHal default values for all configuration options.

lcas

The lcas command sets up LCAS configuration for receive and transmit. This enables configuring the LCAS debug/trace messages. Refer to lcas for full details. The important options and sub-commands of this command are mentioned in the following table:

Table:lcas Options

Member Usage

rsAck

Configure the timeout value for Rs_Ack(s) for Rx Lcas. (default = 10)

holdOff

Configure the hold off timeout for Rx Lcas. (default = 10)

waitToRestore

Configure the wait to restore timeout for the Rx Lcas. (default = 10)

Table:lcas Sub-Commands

Member Usage

cget option

Returns the current value of the configuration option given by option.

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.

get chassis ID cardID portID circuitID

Gets Lcas information for the existing circuit with the given circuit ID.

set chassis ID cardID portID circuitID

Modify Lcas information for the existing circuit with the given circuit ID, if Lcas is enabled in sonetCircuit.

setDefault

Sets to IxTclHal default values for all configuration options..

10GE

Link Fault Signaling

Link fault signalling is implemented on several of the 10GE cards. In addition to several additional statistics which track local and remote faults, the link fault signalling implementation allows local and remote faults to be inserted into transmissions. The following commands are used to control link fault signalling:

linkFaultSignaling

The linkFaultSignaling command is used to a series or continuous stream of link fault signals. The series/stream consists of good and bad period, where the bad periods may send local, remote or custom errors. Errors are called ordered sets; two, named A and B, are available for insertion. The important options and sub-commands of this command are mentioned in the following table:

Table:linkFaultSignaling Options

Member Usage

enableLoopContinuously

loopCount

Enables continuous looping or sets a count for a series.

sendSetsMode

Specifies whether ordered set A and/or B is used in the error insertion.

orderedSetTypeA

orderedSetTypeB

For each of the two ordered set types, indicates whether the type should insert a local error, a remote error or a custom ordered set. Custom ordered sets are defined through the use of the customOrderedSet command.

contiguousErrorBlocks

The number of contiguous 66-bit blocks with errors to insert.

contiguousGoodBlocks

The number of contiguous 66-bit blocks without errors to insert between bad blocks.

Table:linkFaultSignaling Sub-Commands

Member Usage

startErrorInsertion

Starts the error insertion process.

stopErrorInsertion

Stops the error insertion process.

customOrderedSet

The customOrderedSet command is used to define the byte-by-byte contents of a link fault signaling error message. Two sets are maintained: set type A and B. The important options of this command are mentioned in the following table:

Table:customOrderedSet Options

Member Usage

blockType

The type of the error block.

syncBits

The value of the sync bits.

byte1–byte7

The contents of the remaining bytes in the 66-bit block.

txRxPreamble

The txRxPreamble command is used to set the options related to preamble transmit and receive operation on 10GE LAN ports. The important options of this command are mentioned in the following table:

Table: txRxPreamble Options

Member Usage

rxMode

The receive mode for the port: SFD detect, by byte count, or the same as txMode.

txMode

The transmit mode for the port: SFD detect or by byte count.

enableCiscoCDL

Enables the use of Cisco CDL headers instead of the Ethernet header.

enableCDLStats

Enables the collection of CDL statistics and capture.

enablePreambleView

Enables the inclusion of preamble data in the stream packetview.

Optical Digital Wrapper / FEC

The optical digital wrapper provides for generic framing as specified in ITU-T G.709. At the present time, only FEC error insertion is enabled.

opticalDigitalWrapper

This command enables the use of the wrapper. The important options of this command are mentioned in the following table:

Table:opticalDigitalWrapper Options

Member Usage

enableFec

Enables the use of the wrapper and FEC.

enableStuffing

Enables the use of stuffing.

payloadType

The emulated payload type.

fecError

Forward Error Correction (FEC) is a method of communicating data that corrects errors in transmission on the receiving end. Prior to transmission, the data is put through a predetermined algorithm that adds extra bits specifically for error correction to any character or code block. If the transmission is received in error, the correction bits are used to check and repair the data. This feature is only available for certain port types; this may be tested through the use of the portisValidFeature... portFeatureFec command. FEC insertion must be enabled through the use of the Optical Digital Wrapper / FEC command.

fecError command allows you to inject FEC errors into transmitted data. The following modes are controlled by the injectionMode option:

Single errors are inserted with the injectError sub-command and the start and stop commands are used to start and stop rate and burst error insertion. The important options and sub-commands of this command are mentioned in the following table:

Table: fecError Options

Member Usage

injectionMode

Indicates whether a single error, error rate or burst is to be inserted.

errorRate

Indicates the continuous error rate when rate error insertion is used.

burstSize

errorBits

numberOfRowsToSkip

offset

subrow

Options which control the insertion of error bursts.

Table: fecError Sub-Commands

Member

Usage

start

Starts the error insertion process for rate and burst insertion modes.

stop

Stop the error insertion process for rate and burst insertion modes.

injectError

Injects a single error, when the injection mode is set to single error.

CDL Support

Cisco Converged Data Layer (CDL) support is enabled through the use of the txRxPreambleenableCiscoCDL option. When this option is set the cdlPreamble command is used to set up the CDL preamble. The txRxPreambleenableCDLStats option controls the collection of CDL statistics and preamble capture. The txRxPreambleenablePreambleView option controls the format of the stream packetView. When CDL mode is active, the filter command is able to filter on CDL header errors.

cdlPreamble

The cdlPreamble command configures the CDL Preamble that is enabled through the use of the txRxPreambleenableCiscoCDL option. The important options and sub-commands of this command are mentioned in the following table:

Table: cdlPreamble Options

Member Usage

oam

Packet type and OAM information

messageChannel

The in-band message channel

applicationSpecific

Application specific data

enableHeaderCrcOverwrite

headerCrc

Allows the precalculated header to be overridden.

startOfFrame

cdlHeader

Read-only reflections of the start of frame byte and the entire CDL preamble.

Table: cdlPreamble Sub-Commands

Member

Usage

decode

Decodes a captured frame.

xfp

UNIPHY-XFP cards have two additional options that control monitoring of LOS (Loss of Signal) and module ready status. xfp for full details. The important options of this command are mentioned in the following table:

Table:xfp Options

Member Usage

enableMonitorLos

Enables the port to monitor Loss of Signal. In this case, the Loss of Signal status is used to determine Link State.

enableMonitorModuleReadySignal

Enables the port to monitor whether the module is ready. In this case, no transmit, received or statistics operations are performed until the module is ready.

lasi

10GE XENPAK cards have an additional link alarm status interrupt (LASI) set of registers which control the interrupt operation. lasi for full details. The important options of this command are mentioned in the following table:

Table: lasi Options

Member Usage

enableMonitoring

Enables the monitoring of the LASI status registers so as to clear the interrupt signal.

enableAutoDetected

OUIDeviceAddress

Enables the automatic detection of a devices OUI address.

ouiDeviceAddress

The OUI device address of the LASI status registers.

controlRegister

rxAlarmControlRegister

txAlarmControlRegister

The values of the registers which control LASI operation.

Power Over Ethernet

The Power over Ethernet (PoE) ports are controlled by the following commands:

poePoweredDevice

The poePoweredDevice command is used to setup the parameters by which a PoE Powered Device (PD) is emulated on a port. The port can emulate a device that uses either Alternative A and/or Alternative B. This is controlled by the relayControl option. The emulated class is controlled by the enableClassSignature and signatureValue options; the classType indicates the calculated class based on the signature value. The emulated detection signature is controlled by the enableDetectionSignature, rsig, csig and enableCsig10uF options. The emulated Alternating Current Maintain Power Signature (ACMPS) is controlled by the enableAcMpsSignature, rpd, cpd and enable CpdAdd10uF options.

Once the PSE (Power Sourcing Equipment) has classified the emulated PD, it should provide power to the port. The power requirements of the emulated port are controlled by the steadyStateLoadControl, controlledCurrent, controlledPower and idleCurrent options. Transient load variations may be inserted through the use of the enableTransientLoadControl, transientLoadControl, pulseWidth, duty, pulsedCurrent and slewRate options. Pulses are applied through the use of the portGroupsetCommand sub-command, with an loadPoEPulse value or through the high-level ixLoadPoePulse and ixLoadPortPoePulse commands; if enableTransientLoadControl is true and transientLoadControl is set to poeLoadControlSinglePusle, then a pulsed current as indicated by pulsedCurrent and slewRate is injected for the period indicated by pulseWidth.

The voltage thresholds that are used by the PD to detect state transitions may be set by the vOperate, vOff, vClassify, vDetect and vNoop options. The important options and sub-commands of this command are mentioned in the following table:

Table: poePoweredDevice Options

Member Usage

relayControl

Indicates which device Alternatives should be emulated.

enableClassSignature

signatureValue

classType

Control the setting of the class signature.

enableDetectionSignature

rsig

csig

enableCsigAdd10uF

Controls the setting of the detection signature.

enableAcMpsSignature

rpd

rpdRangeControl

cpd

enableCpdAdd10uF

Controls the setting of the ACMPS signature.

steadyStateLoadControl

controlledCurrent

controlledPower

idleCurrent

Controls the steady state power requirements.

enablePulseOnStart

enableTransientLoadControl

transientLoadControl

pulseWidth

duty

pulsedCurrent

slewRate

Controls the application of transient loads.

vOperate

vOff

vClassify

vDetect

vNoop

Controls the state transition voltage thresholds.

Table: poePoweredDevice Sub-Commands

Member Usage

setNominal

Sets nominal values for all types.

poeAutoCalibration

The poePoweredDevice command is used to initiate a PoE port calibration and/or determine the status of a calibration. Calibration of all PoE ports is performed at chassis power-up time.

A calibration is initiated by calling the initiateCalibrate sub-command. The calibration may take up to 20 seconds. The results of a calibration, either while it is preceding or after it has completed, can be determined by first calling requestStatus, waiting a second and then calling get. The status of the calibration is then available through the options in this command. Refer to poeAutoCalibration for complete details. The important options and sub-commands of this command are mentioned in the following table:

Table: poeAutoCalibration Options

Member Usage

currentReadbackStatus

voltageReadbackStatus

iClassRangeStatus

iLoadRangeStatus

iPulseRangeStatus

The current status of the auto-calibration for each item: One of testing, pass or fail.

Table: poeAutoCalibration Sub-Commands

Member

Usage

initiateCalibrate

Starts the calibration process.

requestStatus

Requests the status of the calibration.

get

Reads back the status of the calibration so that it may be read with cget’s.

poeSignalAcquisition

The poeSignalAcquisition command is used to set up and capture the time between two signal transition events. The amplitude of the a signal may also be measured a fixed time after the first signal transition.

The startTriggerSource, startTriggerSlope and startTriggerValue are used to indicate the signal to be used for the first event, the slope that it should transition (positive or negative) and the value that should be matched. Similarly, the stopTriggerSource, stopTriggerSlope and stopTriggerValue are used to indicate the signal to be used for the second event. The enableTime, enableAmplitude and amplitudeMeasurementDelay options are used to condition the measurements made.

Arming of the signal acquisition is accomplished through the use of the portGroup command with the armPoeTrigger value, or the ixArmPoeTrigger and ixArmPortPoeTrigger high-level commands. The arming may be aborted through the use of the portGroup command with the abortPoeTrigger value, or the ixAbortPoeArm and ixAbortPortPoeArm high-level commands.

A number of statistics available through the stat, statGroup, statList and statWatch commands support operation of this command. The status of the arming may be read from the statPoeTimeArmStatus and statPoeAmplitudeArmStatus options. The status of the triggering may be read from the statPoeTimeDoneStatus and statPoEAmplitudeDoneStatus options. The time and amplitude values are visible in the statPoeMonitorTime and statPoeMonitorAmplitudeDCVolts and statPoeMonitorAmplitudeDCAmps options after a trigger has completed.

portGroup

Port groups provide a means of creating a group of ports on which an action may be performed or command may be sent. A single instance of portGroup may be used to maintain a number of groups. portGroup for full details. The important options and sub-commands of this command are mentioned in the following table:

Table: portGroup Options

Member Usage

lastTimestamp

The timestamp, a 64-bit number of nanoseconds, of when the last command was sent to the hardware as a result of a setCommand method execution.

Table: portGroup Sub-Commands

Member Usage

create

Creates a new port group, identified by a unique number.

destroy

Destroys a port group.

add

Adds a port to a port group.

del

Deletes a port from a port group.

canUse

Tests to see whether the current user can use the ports in a group. That is, whether you own the ports or ports are being used by someone else.

setCommand

Performs an action or sends a command to all of the ports in a group.

 

Transmit commands:

  • Start / stop
  • Staggered start
  • Pause
  • Step
  • Clear time stamp

 

Receive:

  • Start / stop capture
  • Reset statistics
  • Start / stop latency
  • Clear latency

 

Protocols:

  • Start/stop each of the protocols
  • Others:
  • Take / clear ownership
  • Force take / clear ownership

clear/set

Scheduled

TransmitTime

Clears or sets the maximum amount of time that a group of ports transmits. This is only valid for ports that support the portFeatureScheduledTxDuration feature, which may be tested with theport isValidFeature command.

write

Sends port properties such as speed, duplex mode and autonegotiation to the hardware. All other values may be sent with writeConfig.

writeConfig

Sends streams, filter and capture parameters to the hardware.