Skip to content

Latest commit

 

History

History
536 lines (365 loc) · 9.34 KB

NftRule.rst

File metadata and controls

536 lines (365 loc) · 9.34 KB
Raw

NftRule

Description

This object was introduced in InCore 2.1.

› Inherits

Object <object_Object>

Overview

Properties

  • connectionStates <property_NftRule_connectionStates>
  • destinationAddress <property_NftRule_destinationAddress>
  • destinationPorts <property_NftRule_destinationPorts>
  • enabled <property_NftRule_enabled>
  • inputInterface <property_NftRule_inputInterface>
  • nonTerminalStatements <property_NftRule_nonTerminalStatements>
  • outputInterface <property_NftRule_outputInterface>
  • protocol <property_NftRule_protocol>
  • sourceAddress <property_NftRule_sourceAddress>
  • sourcePorts <property_NftRule_sourcePorts>
  • statement <property_NftRule_statement>
  • Object.objectId <property_Object_objectId>
  • Object.parent <property_Object_parent>

Methods

  • Object.deserializeProperties() <method_Object_deserializeProperties>
  • Object.fromJson() <method_Object_fromJson>
  • Object.serializeProperties() <method_Object_serializeProperties>
  • Object.toJson() <method_Object_toJson>

Signals

  • nonTerminalStatementsDataChanged() <signal_NftRule_nonTerminalStatementsDataChanged>
  • Object.completed() <signal_Object_completed>

Enumerations

  • ConnectionStates <enum_NftRule_ConnectionStates>
  • Protocol <enum_NftRule_Protocol>
  • Statement <enum_NftRule_Statement>

Properties

single: connectionStates

connectionStates

› Type

ConnectionStates <enum_NftRule_ConnectionStates>

› Default

NftRule.AllStates <enumitem_NftRule_AllStates>

› Signal

connectionStatesChanged()

› Attributes

Writable

single: destinationAddress

destinationAddress

› Type

String

› Signal

destinationAddressChanged()

› Attributes

Writable

single: destinationPorts

destinationPorts

This property holds the destination ports to apply this rule to. See the sourcePorts <property_NftRule_sourcePorts> property for details on syntax and possible values.

› Type

Variant

› Signal

destinationPortsChanged()

› Attributes

Writable

single: enabled

enabled

This property holds whether the rule is enabled, i.e. it should be included in the corresponding chain <object_NftChain>.

› Type

Boolean

› Default

true

› Signal

enabledChanged()

› Attributes

Writable

single: inputInterface

inputInterface

› Type

String

› Signal

inputInterfaceChanged()

› Attributes

Writable

single: nonTerminalStatements

nonTerminalStatements

› Type

List <object_List><NftStatement <object_NftStatement>>

› Signal

nonTerminalStatementsChanged()

› Attributes

Readonly

single: outputInterface

outputInterface

› Type

String

› Signal

outputInterfaceChanged()

› Attributes

Writable

single: protocol

protocol

› Type

Protocol <enum_NftRule_Protocol>

› Default

NftRule.AllProtocols <enumitem_NftRule_AllProtocols>

› Signal

protocolChanged()

› Attributes

Writable

single: sourceAddress

sourceAddress

› Type

String

› Signal

sourceAddressChanged()

› Attributes

Writable

single: sourcePorts

sourcePorts

This property holds the source ports to apply this rule to. Syntax and possible values:

  • 80 – only port 80
  • "!= 33-45" – all ports but 33-45
  • [ 80, 443 ] - ports 80 and 443
› Type

Variant

› Signal

sourcePortsChanged()

› Attributes

Writable

single: statement

statement

› Type

NftStatement <object_NftStatement>

› Signal

statementChanged()

› Attributes

Readonly

Signals

single: nonTerminalStatementsDataChanged

nonTerminalStatementsDataChanged(SignedInteger index)

This signal is emitted whenever the List.dataChanged() <signal_List_dataChanged> signal is emitted, i.e. the item at index in the nonTerminalStatements <property_NftRule_nonTerminalStatements> list itself emitted the dataChanged() signal.

Enumerations

single: ConnectionStates

ConnectionStates

single: NftRule.New

single: NftRule.Established

single: NftRule.Related

single: NftRule.Untracked

single: NftRule.AllStates

Name Value Description
NftRule.New 1
NftRule.Established 2
NftRule.Related 4
NftRule.Untracked 8
NftRule.AllStates 15

single: Protocol

Protocol

single: NftRule.Tcp

single: NftRule.Udp

single: NftRule.UdpLite

single: NftRule.Icmp

single: NftRule.Icmpv6

single: NftRule.Esp

single: NftRule.Ah

single: NftRule.Sctp

single: NftRule.Dccp

single: NftRule.AllProtocols

Name Value Description
NftRule.Tcp 0
NftRule.Udp 1
NftRule.UdpLite 2
NftRule.Icmp 3
NftRule.Icmpv6 4
NftRule.Esp 5
NftRule.Ah 6
NftRule.Sctp 7
NftRule.Dccp 8
NftRule.AllProtocols 9

single: Statement

Statement

single: NftRule.Accept

single: NftRule.Drop

single: NftRule.Queue

single: NftRule.Continue

single: NftRule.Return

single: NftRule.Jump

single: NftRule.GoTo

single: NftRule.Log

single: NftRule.Reject

single: NftRule.Counter

single: NftRule.Limit

single: NftRule.Nat

Name Value Description
NftRule.Accept 0
NftRule.Drop 1
NftRule.Queue 2
NftRule.Continue 3
NftRule.Return 4
NftRule.Jump 5
NftRule.GoTo 6
NftRule.Log 7
NftRule.Reject 8
NftRule.Counter 9
NftRule.Limit 10
NftRule.Nat 11

Example

See NftFirewall example <example_NftFirewall> on how to use NftRule.