Data Capture and Statistics
The commands in this section relate to setup for data capture, initiating data capture and collection of statistics. Although this section follows the one on data transmission, all capture setup and initiation should be done before any data transmission is started. The commands covered in this section are as follows:
- Setup
- ixSetPortCaptureMode / ixSetCaptureMode
- ixSetPortPacketGroupMode / ixSetPacketGroupMode
- ixClearTimeStamp
- ixClearPortStats / ixClearStats
- ixClearPortPacketGroups/ ixClearPacketGroups
- ixResetSequenceIndex/ ixResetPortSequenceIndex
- Capture Data
- ixStartPortCapture / ixStartCapture / ixStopPortCapture / ixStopCapture
- ixStartPortPacketGroups / ixStartPacketGroups / ixStopPortPacketGroups / ixStopPacketGroups
- Statistics
Setup
The data capture and statistics setup commands should be performed before any data capture operations are started.
ixSetPortCaptureMode / ixSetCaptureMode
These commands sends a message to the IxServer to set the receive mode of a single port or list of ports to Capture mode. This mode must be used when traffic is to be captured in the capture buffer. This mode is mutually exclusive with the Packet Group receive mode. The format of these commands are as follows:
ixSetPortCaptureMode chassisID cardID portID [write]
ixSetCaptureMode portList [write]
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports. The write argument commits the settings to the hardware immediately.
Refer to “ixSetPortCaptureMode” and “ixSetCaptureMode” for a full description of these commands.
ixSetPortPacketGroupMode / ixSetPacketGroupMode
These commands send a message to the IxServer to set the receive mode of a single port or list of ports to Packet Group mode. This mode must be used when real-time latency metrics are to be obtained. This mode is mutually exclusive with the Capture receive mode, for some modules. The format of these commands are as follows:
ixSetPortPacketGroupMode chassisID cardID portID [write]
ixSetPacketGroupMode portList [write]
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports. The write argument commits the settings to the hardware immediately.
Refer to “ixSetPortPacketGroupMode” and “ixSetPacketGroupMode” for a full description of these commands.
ixSetPortDataIntegrityMode / ixSetDataIntegrityMode
These commands send a message to the IxServer to set the receive mode of a single port or list of ports to Data Integrity mode. The format of these commands are:
ixSetPortDataIntegrityMode chassisID cardID portID [write]
ixSetDataIntegrityMode portList [write]
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports. The write argument commits the settings to the hardware immediately.
Refer to “ixSetPortDataIntegrityMode” and “ixSetDataIntegrityMode” for a full description of these commands.
ixSetPortSequenceCheckingMode / ixSetSequenceCheckingMode
These commands send a message to the IxServer to set the receive mode of a single port or list of ports to Sequence Checking mode. The format of these commands are as follows:
ixSetPortSequenceCheckingMode chassisID cardID portID [write]
ixSetSequenceCheckingMode portList [write]
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports. The write argument commits the settings to the hardware immediately.
Refer to “ixSetPortSequenceCheckingMode” and “ixSetSequenceCheckingMode” for a full description of these commands.
ixClearTimeStamp
The ixClearTimeStamp command sends a message to the IxServer to synchronize the timestamp on a group of chassis. This feature is useful for calculating latency on ports across chassis. The format of this command is as follows:
ixClearTimeStamp portList
where portList identifies a number of ports.
Refer to “ixClearTimeStamp” for a full description of this command.
ixClearPortStats / ixClearStats
These commands clear all of the statistics counters on a single port or list of ports (except for the stats in the Latency/Sequence view). The format of these commands is as follows:
ixClearPortStats chassisID cardID portID
ixClearStats portList
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports.
Refer to “ixClearPortStats” and “ixClearStats” for a full description of these commands.
ixClearPortPacketGroups/ ixClearPacketGroups
These commands clear all of the packet group counters on a single port or list of ports. The format of these commands is as follows:
ixClearPortPacketGroups chassisID cardID portID
ixClearPacketGroups portList
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports.
Refer to “ixClearPacketGroups” and “ixClearPortPacketGroups” for a full description of these commands.
ixResetSequenceIndex/ ixResetPortSequenceIndex
These commands send a message to the IxServer to reset the sequence index of a single port or a list of ports. The format of these commands are as follows:
ixResetPortSequenceIndex chassisID cardID portID [write]
ixResetSequenceIndex portList [write]
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports. The write argument commits the settings to the hardware immediately.
Note: The ixResetSequenceIndex command should be used before you start any traffic transmission.
Refer to “ixResetSequenceIndex” and “ixResetPortSequenceIndex” for a full description of these commands.
Capture Data
ixStartPortCapture / ixStartCapture / ixStopPortCapture / ixStopCapture
These commands start and stop port capture on a single port or on a group of ports. The format of these commands is as follows:
ixStartPortCapture chassisID cardID portID
ixStartCapture portList
ixStopPortCapture chassisID cardID portID
ixStopCapture portList
where chassisID, cardID, and portID identify a single port and portList identifies a number of ports.
Refer to “ixStartPortCapture”, “ixStartCapture”, “ixStopPortCapture”and “ixStopCapture” for complete descriptions of these commands.
ixStartPortPacketGroups / ixStartPacketGroups / ixStopPortPacketGroups / ixStopPacketGroups
These commands start and stop calculation of real-time latency metrics on a single port or on a group of ports. Both packet groups and wide packet groups count the number of frames received per packet group ID (PGID) and calculate the minimum, maximum and average latencies. The format of these commands is as follows:
ixStartPortPacketGroups chassisID cardID portID
ixStarts portList
ixStopPortPacketGroups chassisID cardID portID
ixStopPacketGroups portList
where chassisID, cardID, and portID identifies a single port and portList identifies a number of ports.
Refer to “ixStartPacketGroups”, “ixStartPortPacketGroups”, “ixStopPortPacketGroups”and “ixStopPacketGroups” for complete descriptions of these commands.
Statistics
ixCollectStats
This command gathers the same specified statistic from a number of ports and places the results in a return array. The format of this command is as follows:
ixCollectStats portList statName RxStats TotalStats
where portList identifies a number of ports to collect statistics from, statName is the name of the statistic to collect, RxStats is the returned array of statistics and TotalStats is the returned total number of frames (that is, the sum of RxStats). statName must match one of the standard options defined in the stat command (“stat”). RxStats is an array whose indices are the ports over which the statistics were collected.
Note that the RxStats indices are separated by commas and not spaces as in other array references used with maps. Also recall that most of the statistics collected are 64-bit values, as indicated in the stat command. Calculations on these values should be performed using the mpexpr command.
Refer to “ixCollectStats” for a full description of this command.
ixRequestStats
This command requests that the statistics associated with a list of ports or a port map be retrieved at the same time. The statistics are then read using the statList command. The format of the command is as follows:
ixRequestStats portList
where portList identifies a map name or list of ports.