CaptureFilterStopEvent Object


Description:

Events that specify when to stop capturing frames.

Automatically created from: Capture

CaptureFilterStopEvent 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

Stop capturing frames upon matching an FCS error.

EXCLUDE

Do not stop capturing frames upon matching an FCS error.

FilterExpression

Read-only option.

Type: string

Default: { None }

FilterName

Stop event filter name.

Type: string

Default: "" (empty string)

FrameLength

Length of frame when FrameLenMatch 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

Stop capturing frames upon matching the specified frame length.

EXCLUDE

Do not stop capturing frames upon matching 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

Stop capturing frames upon matching an IGMP frame.

EXCLUDE

Do not stop capturing frames upon matching an IGMP frame.

Ipv4

IPv4 option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv4 option.

INCLUDE

Stop capturing frames upon matching an IPv4 frame.

EXCLUDE

Do not stop capturing frames upon matching an IPv4 frame.

Ipv4CheckSumError

IPv4 checksum error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv4 checksum error option.

INCLUDE

Stop capturing frames upon matching an IPv4 checksum error.

EXCLUDE

Do not stop capturing frames upon matching an IPv4 checksum error.

Ipv6

IPv6 option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the IPv6 option.

INCLUDE

Stop capturing frames upon matching an IPv6 frame.

EXCLUDE

Do not stop capturing frames upon matching an IPv6 frame.

Jumbo

Jumbo frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the jumbo frame option.

INCLUDE

Stop capturing frames upon matching a jumbo frame.

EXCLUDE

Do not stop capturing frames upon matching a jumbo frame.

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

Stop capturing frames upon matching a layer 1 error.

EXCLUDE

Do not stop capturing frames upon matching a layer 1 error.

Oversized

Oversized frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the oversized frame option.

INCLUDE

Stop capturing frames upon matching an oversized frame.

EXCLUDE

Do not stop capturing frames upon matching an oversized frame.

PrbsError

PRBS error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the PRBS error option.

INCLUDE

Stop capturing frames upon matching a PRBS error.

EXCLUDE

Do not stop capturing frames upon matching a PRBS error.

SigPresent

Spirent signature option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the Spirent signature option.

INCLUDE

Stop capturing frames upon matching a Spirent signature.

EXCLUDE

Do not stop capturing frames upon matching a 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.

StopEvents

Use this option to stop capturing frames upon matching the specified data pattern.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables pattern matching stop events.

FALSE

Disables pattern matching stop events.

StreamId

ID of stream when StreamIdMatch 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

Stop capturing frames upon matching the specified stream ID.

EXCLUDE

Do not stop capturing frames upon matching the specified stream ID.

Tcp

TCP option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the TCP option.

INCLUDE

Stop capturing frames upon matching a TCP frame.

EXCLUDE

Do not stop capturing frames upon matching a TCP frame.

TcpUdpIgmpCheckSumError

TCP/UDP checksum error option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the TCP/UDP checksum error option.

INCLUDE

Stop capturing frames upon matching a TCP/UDP checksum error.

EXCLUDE

Do not stop capturing frames upon matching a TCP/UDP checksum error.

Udp

UDP option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the UDP option.

INCLUDE

Stop capturing frames upon matching a UDP frame.

EXCLUDE

Do not stop capturing frames upon matching a UDP frame.

Undersized

Undersized frame option.

Type: enum

Default: IGNORE

Possible Values:

Value Description
IGNORE

Ignore the undersized frame option.

INCLUDE

Stop capturing frames upon matching an undersized frame.

EXCLUDE

Do not stop capturing frames upon matching an undersized frame.

CaptureFilterStopEvent Read-Only Attributes

There are no read-only attributes.