CaptureFilter Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Represents the preset capture filter options. Logical OR is applied on the properties.

Children: CaptureAnalyzerFilter, CapturePatternExpression

Automatically created from: Capture

CaptureFilter Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
FcsError

FCS error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the FCS error option.
INCLUDE

Capture frames that contain FCS errors.
EXCLUDE

Do not capture frames that contain FCS errors.
FilterExpression

Read-only option.

Type: string

Default: { None }
FilterName

Event filter name.

Type: string

Default: "" (empty string)

FrameLength

Length of frame when FrameLenMatch option is selected.

Type: u32

Default: 0
FrameLenMatch

Match specified frame length.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the frame length match option.
INCLUDE

Capture frames that match the specified frame length.
EXCLUDE

Do not capture frames that match the specified frame length.
GuiExpression

Read-only option.

Type: string

Default: "" (empty string)

Igmp

IGMP option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IGMP option.
INCLUDE

Capture IGMP frames.
EXCLUDE

Do not capture IGMP frames.
Ipv4

IPv4 option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv4 option.
INCLUDE

Capture IPv4 frames.
EXCLUDE

Do not capture IPv4 frames.
Ipv4CheckSumError

IPv4 checksum error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv4 checksum error option.
INCLUDE

Capture frames that contain IPv4 checksum errors.
EXCLUDE

Do not capture frames that contain IPv4 checksum errors.
Ipv6

IPv6 option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv6 option.
INCLUDE

Capture IPv6 frames.
EXCLUDE

Do not capture IPv6 frames.
Jumbo

Jumbo frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the jumbo frame option.
INCLUDE

Capture frames that are jumbo.
EXCLUDE

Do not capture frames that are jumbo.
L1Error

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

L1 error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the L1 error option.
INCLUDE

Capture frames that contain layer 1 errors.
EXCLUDE

Do not capture frames that contain layer 1 errors.
Oversized

Oversized frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the oversized frame option.
INCLUDE

Capture frames that are oversized.
EXCLUDE

Do not capture frames that are oversized.
PrbsError

PRBS error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the PRBS error option.
INCLUDE

Capture frames that contain PRBS errors.
EXCLUDE

Do not capture frames that contain PRBS errors.
QualifyEvents

Use this option to capture all frames that match the specified event.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enables capturing frames that match specified event.
FALSE

Disables capturing frames that match specified event.
SigPresent

Spirent signature option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore Spirent signature option.
INCLUDE

Capture frames with Spirent signature.
EXCLUDE

Do not capture frames with Spirent signature.
SigSeqNumError

Signature sequence error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the signature sequence error option.
INCLUDE

Capture frames that contain signature sequence errors.
EXCLUDE

Do not capture frames that contain signature sequence errors.
StreamId

ID of stream when StreamIdMatch option is selected.

Type: u32

Default: 0
StreamIdMatch

Match specified stream ID.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the Stream ID Match option.
INCLUDE

Capture frames that match the specified stream ID.
EXCLUDE

Do not capture frames that match the specified stream ID.
Tcp

TCP option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the TCP option.
INCLUDE

Capture TCP frames.
EXCLUDE

Do not capture TCP frames.
TcpUdpIgmpCheckSumError

TCP/UDP checksum error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the TCP/UDP checksum error option.
INCLUDE

Capture frames that contain TCP/UDP checksum errors.
EXCLUDE

Do not capture frames that contain TCP/UDP checksum errors.
Udp

UDP option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the UDP option.
INCLUDE

Capture UDP frames.
EXCLUDE

Do not capture UDP frames.
Undersized

Undersized frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the undersized frame option.
INCLUDE

Capture frames that are undersized.
EXCLUDE

Do not capture frames that are undersized.

CaptureFilter Read-Only Attributes

There are no read-only attributes.