Operator IPFilter
This operator filters IPv4 addresses based on a list of IPv4 addresses input in CIDR format.
Summary
- Ports
- This operator has 2 input ports and 1 output port.
- Windowing
- This operator does not accept any windowing configurations.
- Parameters
- This operator supports 2 parameters.
Required: inputIPAttr
Optional: inputIPAttr2
- Metrics
- This operator does not report any metrics.
Properties
- Implementation
- C++
- Threading
- Never - Operator never provides a single threaded execution context.
- Ports (0)
-
Ingests tuples containing IP addresses and filters the data based on those addresses. The inputIPAttr parameter specifies the attribute containing the IP addresses.
- Properties
-
- Optional: false
- ControlPort: false
- TupleMutationAllowed: false
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Ports (1)
-
Control port that takes in tuples containing IPv4 addresses in CIDR format for use in the filter operation. All packets that match one of the input address ranges are passed through the filter.
This control port can be used to dynamically update the list of addresses being filtered. Each time a tuple is received containing an address it is saved in a temporary list that is applied after a window punctuation is received. This input port expects a tuple containing a single attribute of type rstring which is an IPv4 address in CIDR format (e.g. 192.168.0.0/24).
- Properties
-
- Optional: false
- ControlPort: true
- TupleMutationAllowed: false
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Assignments
- This operator does not allow assignments to output attributes.
- Ports (0)
-
Submits a tuple for each input tuple received on input port 0 if one or more of the attributes defined in the inputIPAttr paramater match an IPv4 address that has been input on the control port.
- Properties
-
- Optional: false
- TupleMutationAllowed: false
- WindowPunctuationOutputMode: Preserving
Required: inputIPAttr
Optional: inputIPAttr2
- inputIPAttr
-
Specifies the input attribute(s) containing the IPv4 address (or IPv4 addresses) that the filter will be applied against. The supported data types for this attribute are uint32 and list<uint32>.
- Properties
-
- Cardinality: 1
- Optional: false
- ExpressionMode: Expression
- inputIPAttr2
-
Specifies an additional input attribute containing an additional IPv4 address (or IPv4 addresses) that the filter will be applied against. The supported data types for this attribute are uint32 and list<uint32>.
- Properties
-
- Cardinality: 1
- Optional: true
- ExpressionMode: Expression