flowbits Keyword Options

The following table describes the various combinations of operators, states, and groups available to the flowbits keyword. Note that state names can contain alphanumeric characters, periods (.), underscores (_), and dashes (-).

flowbits Options

Operator

State Option

Group

Description


set

state_name

optional

Sets the specified state for a packet. Sets the state in the specified group if a group is defined.


set

state_name&state_name

optional

Sets the specified states for a packet. Sets the states in the specified group if a group is defined.


setx

state_name

mandatory

Sets the specified state in the specified group for a packet, and unsets all other states in the group.


setx

state_name&state_name

mandatory

Sets the specified states in the specified group for a packet, and unsets all other states in the group.


unset

state_name

no group

Unsets the specified state for a packet.


unset

state_name&state_name

no group

Unsets the specified states for a packet.


unset

all

mandatory

Unsets all the states in the specified group.


toggle

state_name

no group

Unsets the specified state if it is set, and sets the specified state if it is unset.


toggle

state_name&state_name

no group

Unsets the specified states if they are set, and sets the specified states if they are unset.


toggle

all

mandatory

Unsets all states set in the specified group, and sets all states unset in the specified group.


isset

state_name

no group

Determines if the specified state is set in the packet.


isset

state_name&state_name

no group

Determines if the specified states are set in the packet.


isset

state_name|state_name

no group

Determines if any of the specified states are set in the packet.


isset

any

mandatory

Determines if any state is set in the specified group.


isset

all

mandatory

Determines if all states are set in the specified group.


isnotset

state_name

no group

Determines if the specified state is not set in the packet.


isnotset

state_name&state_name

no group

Determines if the specified states are not set in the packet.


isnotset

state_name|state_name

no group

Determines if any of the specified states is not set in the packet.


isnotset

any

mandatory

Determines if any state is not set in the packet.


isnotset

all

mandatory

Determines if all states are not set in the packet.


reset

(no state)

optional

Unsets all states for all packets. Unsets all states in a group if a group is specified.


noalert

(no state)

no group

Use this in conjunction with any other operator to suppress event generation.