Capture Object

Description:

Provides for capturing frame data during a test. Eight 4-byte pattern matching filters and 19 trigger events can be created and combined to capture 8 to 16 MB of control and data plane traffic per port.

Writable Attributes
Read-Only Attributes

Children: CaptureBytePattern, CaptureRangePattern, CaptureStatisticsFilter

Automatically created from: Port

Automatically-created children: CaptureFilter, CaptureFilterStartEvent, CaptureFilterStopEvent, CaptureIeee80211, CaptureRawPacketTagsInfo

Capture Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AbortSaveTask

Allows the user to abort saving a file while saving. Internal Use Only.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Abort the file saving task.
FALSE	Do not abort the file saving task.

BufferMode

What to do when the capture buffer is full.

Type: enum

Default: WRAP

Possible Values:

Value	Description
WRAP	When the buffer is full, roll over and continue.
STOP_ON_FULL	When the buffer is full, stop.

CaptureFilterMode

Filter mode to use.

Type: enum

Default: FRAMECONTENT

Possible Values:

Value	Description
FRAMECONTENT	Filter packets based on the content of protocol fields.
BYTEOFFSETANDRANGE	Filter packets based on a specific byte offset and value, frame length range, or both.
IEEE80211FRAMECONTENT	Filter packets based on client's SSID, MAC address, management, control, and data frames.

CurrentFilterBytesUsed

Internally used by GUI. No use-case from automation.

Type: u32

Default: 0

Range: 0 - 32

CurrentFiltersUsed

Internally used by GUI. No use-case from automation.

Type: u32

Default: 0

Range: 0 - 8

CurrentTask

Internally used by GUI. No use-case from automation.

Type: enum

Default: IDLE

Possible Values:

Value	Description
IDLE	No tasks are being performed. Internal use only.
SAVING	Currently saving buffer to file. Internal use only.
RETRIEVING	Retrieving captured packets. Internal use only.

ElapsedTime

Start capture elapsed time.

Type: string

Default: 0:00:00

FlagMode

Flag mode for capture.

Type: enum

Default: REGULAR_FLAG_MODE

Possible Values:

Value	Description
REGULAR_FLAG_MODE	Regular flag mode.
ADV_SEQ_FLAG_MODE	Advance sequence flag mode.

Ieee80211FilterString

Filter query string for IEEE 802.11 ports captured packets.

Type: string

Default: "" (empty string)

IncreasedMemorySupport

Indicate if increasing capture buffer size is supported.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Increasing capture buffer size is supported.
FALSE	Increasing capture buffer size is not supported.

Mode

Indicates what to capture.

Type: enum

Default: REGULAR_MODE

Possible Values:

Value	Description
REGULAR_MODE	Capture the entire Ethernet frame from the SFPGA.
SIG_MODE	Capture only the signature tags in 16-byte frames.
IEEE80211_MODE	(Shared Radio) Capture all traffic received from the wireless network. Shared by all ports.
IEEE80211_REGULAR_MODE	(Dedicated Radio) Capture frames which have IEEE 802.11 header. Per port. Data is captured from the NIC.
IEEE80211_OFDMA_MODE	(Dedicated Radio) Capture or analyze OFDMA frames.

RealTimeBufferStatus

Internally used by GUI. No use-case from automation.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Buffer is full and ready for reading. Internal use only.
FALSE	Buffer has been populated. Internal use only.

RealTimeFramesBuffer

Internally used by GUI. No use-case from automation.

Type: u8

Default: 0

RealTimeMode

Use this option to enable or disable real-time capture.

Note: Real-time capture supports a maximum of 4 ports.

Type: enum

Default: REALTIME_DISABLE

Possible Values:

Value	Description
REALTIME_DISABLE	Disables real-time capture.
REALTIME_ENABLE	Enables real-time capture.

SaveBufferWithPreamble

Flag to indicate if preamble is saved in buffer.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Preamble is saved in buffer.
FALSE	Preamble is not saved in buffer.

SliceCaptureSize

Indicates the length of data in bytes to be saved when SliceMode is enabled.

Type: u32

Default: 128

Range: 32 - 4000

SliceMode

Use this option to save only the specified length of the frames.

Type: enum

Default: DISABLE

Possible Values:

Value	Description
DISABLE	Disables slice mode.
ENABLE	Enables slice mode.

SliceOffset

Indicates the offset in bytes from the specified slice offset reference.Only even values are supported.

Type: u32

Default: 0

SliceOffsetRef

Indicates the slice offset reference. Used only when SliceMode is enabled.

Type: enum

Default: PREAMBLE

Possible Values:

Value	Description
PREAMBLE	Offset reference is Preamble.
FRAME	Offset reference is start of frame.
IP	Offset reference is start of IP header.
IP_PAYLOAD	Offset reference is start of IP payload.

SrcMode

Indicates the source for capture data.

Type: enum

Default: TX_RX_MODE

Possible Values:

Value	Description
TX_MODE	Only control plane transmitted packets are captured.
RX_MODE	Only received frames (control and data plane) traffic are captured.
TX_RX_MODE	Transmitted and received frames are captured.

Start

Indicates the start event for capture (internal use only).

Type: u32

Default: 0x00004000

Stop

Indicates the stop event for capture (internal use only).

Type: u32

Default: 0x00000000

TabIndex

Internally used by GUI. No use-case from automation.

Type: u32

Default: 0

Capture Read-Only Attributes

Read-Only Attribute

Description

CaptureState

Indicates the current state of capture on card.

Type: enum

Default: READY

Possible Values:

Value	Description
READY	Capture daemon is ready, but has not been started.
RUNNING	Capture daemon on card is currently capturing frames.
PENDING	Capture daemon state between start and running, and running to stop.
UNAVAILABLE	Capture daemon is not available.

PktCount

Count of captured packets. This count is updated when the capture stops.

Type: u32

Default: 0

PktSavedCount

Indicates the current number of packets saved when data is saved.

Type: u32

Default: 0