FilterPy

SCPI Commands

CONFigure:DATA:MEASurement<MeasInstance>:IPANalysis:IPConnect:FILTer:EXTension
CONFigure:DATA:MEASurement<MeasInstance>:IPANalysis:IPConnect:FILTer
class FilterPy[source]

FilterPy commands group definition. 2 total commands, 0 Sub-groups, 2 group commands

class ExtensionStruct[source]

Structure for reading output parameters. Fields:

  • Filter_1_On_Off: bool: OFF | ON ON: filter line 1 enabled OFF: filter line 1 disabled

  • Filter_1_Type: enums.FilterType: FLOWid | IPADd | L4PR | L7PRotocol | APPL | CTRY | SRCP | DSTP Selects the property to be checked by filter line 1. FLOWid: flow IDs IPADd: IP addresses L4PR: L4 protocol L7PRotocol: L7 protocol APPL: application CTRY: country SRCP: source port DSTP: destination port

  • Filter_1_String: str: Single string, containing all filter criteria for filter line 1. For rules, see ‘Filter expressions’.

  • Filter_2_On_Off: bool: OFF | ON ON: filter line 2 enabled OFF: filter line 2 disabled

  • Filter_2_Type: enums.FilterType: FLOWid | IPADd | L4PR | L7PRotocol | APPL | CTRY | SRCP | DSTP Selects the property to be checked by filter line 2.

  • Filter_2_String: str: Single string, containing all filter criteria for filter line 2.

  • Filter_3_On_Off: bool: OFF | ON ON: filter line 3 enabled OFF: filter line 3 disabled

  • Filter_3_Type: enums.FilterType: FLOWid | IPADd | L4PR | L7PRotocol | APPL | CTRY | SRCP | DSTP Selects the property to be checked by filter line 3.

  • Filter_3_String: str: Single string, containing all filter criteria for filter line 3.

  • Filter_4_On_Off: bool: OFF | ON ON: filter line 4 enabled OFF: filter line 4 disabled

  • Filter_4_Type: enums.FilterType: FLOWid | IPADd | L4PR | L7PRotocol | APPL | CTRY | SRCP | DSTP Selects the property to be checked by filter line 4.

  • Filter_4_String: str: Single string, containing all filter criteria for filter line 4.

class ValueStruct[source]

Structure for reading output parameters. Fields:

  • Filter_Type: enums.FilterType: No parameter help available

  • Filter_String: str: No parameter help available

get_extension() → ExtensionStruct[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPANalysis:IPConnect:FILTer:EXTension
value: ExtensionStruct = driver.configure.data.measurement.ipAnalysis.ipConnect.filterPy.get_extension()

Configures a flow filter for IP analysis results. For views supporting the filter, the evaluated set of flows is restricted according to the filter settings. The filter combines all enabled filter lines via AND. You can configure up to four filter lines. If you skip setting parameters, the related filter lines are not modified. A query returns all parameters, including the optional ones.

return

structure: for return value, see the help for ExtensionStruct structure arguments.

get_value() → ValueStruct[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPANalysis:IPConnect:FILTer
value: ValueStruct = driver.configure.data.measurement.ipAnalysis.ipConnect.filterPy.get_value()

No command help available

return

structure: for return value, see the help for ValueStruct structure arguments.

set_extension(value: RsCmwDau.Implementations.Configure_.Data_.Measurement_.IpAnalysis_.IpConnect_.FilterPy.FilterPy.ExtensionStruct) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPANalysis:IPConnect:FILTer:EXTension
driver.configure.data.measurement.ipAnalysis.ipConnect.filterPy.set_extension(value = ExtensionStruct())

Configures a flow filter for IP analysis results. For views supporting the filter, the evaluated set of flows is restricted according to the filter settings. The filter combines all enabled filter lines via AND. You can configure up to four filter lines. If you skip setting parameters, the related filter lines are not modified. A query returns all parameters, including the optional ones.

param value

see the help for ExtensionStruct structure arguments.

set_value(value: RsCmwDau.Implementations.Configure_.Data_.Measurement_.IpAnalysis_.IpConnect_.FilterPy.FilterPy.ValueStruct) → None[source]
# SCPI: CONFigure:DATA:MEASurement<Instance>:IPANalysis:IPConnect:FILTer
driver.configure.data.measurement.ipAnalysis.ipConnect.filterPy.set_value(value = ValueStruct())

No command help available

param value

see the help for ValueStruct structure arguments.