Properties

Reference Documentation

Platform
Napatech SmartNIC
Content Type
Reference Information
Capture Software Version
Link™ Capture Software 12.15
Napatech Software Suite: Properties

The Napatech Software Suite internally maintains a number of properties.

These properties can be queried by applications that wish to obtain information about
the capabilities of the Napatech driver and installed adapters.

Properties are addressed in a hierarchical fashion. For example: Adapter0.FpgaGeneration
addresses the FpgaGeneration property on adapter 0.

It is also possible to query ini-file settings through the properties interface. These
settings are located under the ini "section". If, for example, an application
wishes to read the "HostBufferHandlerAffinity" setting on adapter 2 the following address
should be used: ini.Adapter2.HostBufferHandlerAffinity

Note
An adapter property's existence does not depend on the adapter type.
All adapters have the same properties regardless of adapter and FPGA generation, but the values of the properties depend on whether the adapter supports the given capabilities.


System properties
Properties in the system section are system wide.

Adapter properties
The adapter section contains properties that are specific to a particular adapter.

See below for a description of the available properties.

Section
Parameter Description Possible values
Adapter
FpgaGeneration Specifies FPGA generation on adapter

2: 2nd generation FPGA
3: 3rd generation FPGA
4: 4th generation FPGA

PortOffset Offset of the starting port on adapter
PortCount Number of ports on adapter
RxHostBuffersCfg Number of Rx hostbuffers configured
TxHostBuffersCfg Number of Tx hostbuffers configured
RxHostBuffersMax Maximum number of Rx hostbuffers supported by FPGA
TxHostBuffersMax Maximum number of Tx hostbuffers supported by FPGA
Adapter.Filter
VnTag Indicates the level of VN-TAG filtering supported

0: Not supported
1: Supported

IpMatch Indicates whether the adapter supports IPMatch matching

0: Not supported
1: Supported

KeyMatch Indicates the level of key matching supported

0: Not supported
1: Level 1 Supported
2: Level 2 Supported (bitmasks and improved key mapping)

FlowMatch Indicates the level of flow matching supported

0: Not supported
1: Supported: non-stateful
2: Supported: stateful

Toeplitz Indicates whether the Toeplitz hash algorithm is supported

0: Not supported
1: Supported

PcapFcsInclude Indicates whether the ini setting "PacketPcapFcsInclude" is supported

0: Not supported
1: Supported

CorrelationKey Indicates whether correlation key functionality is supported

0: Not supported
1: Supported

Deduplication Indicates whether the adapter supports deduplication

0: Not supported
1: Supported

Masking Indicates whether the adapter supports masking

0: Not supported
1: Supported

Action Indicates whether the adapter supports the NTPL command Action

0: Not supported
1: Supported

HeaderStripping Indicates whether the adapter supports header stripping

0: Not supported
1: Supported

Adapter.Filter.Action
VlanInsertion Indicates whether the adapter supports VLAN insertion

0: Not supported
1: Supported

Adapter.Filter.Deduplication
WindowSize Size of deduplication window Size is given in µs
TableSize Size of deduplication hash table Number of internal entries in the FPGA deduplication hash table
Adapter.Filter.FlowMatch
FlmVersion Flow Matcher Version


FlmCapacity Flow Matcher Table size

MB

FlmEntrySize Flow Matcher Entry size

bytes

Adapter.ProtocolTest
EoMPLS Indicates whether the adapter supports the EoMLPS protocol

0: not supported
1: supported

Isl Indicates whether the adapter's packet decoder supports the ISL protocol

0: not supported
1: supported

MacAddresses Indicates whether the adapter's packet decoder supports MAC Addresses

0: not supported
1: supported

Vlan Indicates whether the adapter supports VLAN tagging

0: not supported
1: supported

NovellRaw Indicates whether the adapter supports the Novell Raw Ethernet frames

0: not supported
1: supported

Snap Indicates whether the adapter supports the SubNetwork Access Protocol (SNAP).

0: not supported
1: supported

Llc Indicates whether the adapter supports the Logical Link Control (LLC) protocol

0: not supported
1: supported

Ether2 Indicates whether the adapter supports the Ether2 protocol

0: not supported
1: supported

MPLS Indicates whether the adapter supports the Multi Protocol Label Switching (MPLS) protocol

0: not supported
1: supported

IPv4 Indicates whether the adapter supports the IPv4 protocol

0: not supported
1: supported

IPv6 Indicates whether the adapter supports the IPv6 protocol

0: not supported
1: supported

UDP Indicates whether the adapter supports the UPP protocol

0: not supported
1: supported

TCP Indicates whether the adapter supports the TCP protocol

0: not supported
1: supported

SCTP Indicates whether the adapter supports the Stream Control Transmission Protocol (SCTP).

0: not supported
1: supported

ICMP Indicates whether the adapter supports the Internet Control Message Protocol (ICMP)

0: not supported
1: supported

GRE Indicates whether the adapter supports the Generic Routing Encapsulation (GRE) protocol

0: not supported
1: supported

IPinIP Indicates whether the adapter supports IPinIP encapsulation.

0: not supported
1: supported

EtherIP Indicates whether the adapter supports EtherIP.

0: not supported
1: supported

GTP Indicates whether the adapter supports the GPRS Tunneling Protocol (GTP).

0: not supported
1: supported

VXLAN Indicates whether the adapter supports VXLAN encapsulation.

0: not supported
1: supported

CFP Indicates whether the adapter supports Cisco Fabric Path (CFP)

0: not supported
1: supported

PPPoE Indicates whether the adapter supports Point-to-Point Protocol over Ethernet (PPPoe)

0: not supported
1: supported

VnTag Indicates the level of VN-TAG filtering supported

0: Not supported
1: Supported

ERSPAN Indicates whether the adapter packet decoder supports Encapsulated Remote Switched Port Analyzer (ERSPAN)

0: not supported
1: supported

AristaTSHeader Indicates whether the adapter packet decoder supports Arista 7280R/7500R Self-Contained Timestamp header

0: not supported
1: supported

AristaTSExtraction Indicates whether the adapter packet descriptor supports Arista 7280R/7500R Timestamp Extraction

0: not supported
1: supported

Adapter.Rx
ChecksumMode Indicates whether Rx Checksum can be checked for outer, inner, or both headers.

0: Not supported (always outer)
1: False / true supported (outer/inner)
2: False / true / or supported (outer/inner/both)

Sdram Indicates whether Rx SDRAM buffer is supported

0: Not supported
1: Supported

Adapter.Rx.Sdram
Capacity Rx SDRAM buffer size MB
Split Indicates whether the adapter supports SDRAM split

0: Not supported
1: Supported

Adapter.TimeSync
Ext1 Specifies whether timesync connector Ext1 is supported

0: Not supported
1: Supported

Int1 Specifies whether timesync connector Int1 is supported

0: Not supported
1: Supported

Int2 Specifies whether timesync connector Int2 is supported

0: Not supported
1: Supported

PTP Specifies whether FPGA supports TimeSync PTP feature

0: Not supported
1: Supported

OsTime Specifies whether FPGA supports TimeSync OsTime feature

0: Not supported
1: Supported

FreeRun Specifies whether FPGA supports TimeSync FreeRun feature

0: Not supported
1: Supported

Ntts Specifies whether FPGA supports TimeSync Ntts feature

0: Not supported
1: Supported

PPS Specifies whether FPGA supports TimeSync PPS feature

0: Not supported
1: Supported

ClockAdjustmentMode Specifies the supported TimeSync clock adjustment mode
Adapter.Tx
LiveReconfig Specifies whether 4GA FPGA support GFG reconfiguration with live TX

0: Not supported
1: Supported

ZeroCopyTransmit Specifies whether 4GA FPGA has zero-copy transmit

0: Not supported
1: Supported

TimedTransmit Specifies whether 4GA FPGA supports configurable transmit timestamp formats

0: Not supported
1: Supported

UndersizedPacket Specifies whether FPGA supports undersized packet Tx

0: Not supported
1: Supported

IgnoreWireLenZeroPacket Specifies whether FPGA supports Tx Ignore on packets with wirelen zero

0: Not supported
1: Supported

System
StreamsMax Specifies maximum number of streams supported
StreamIdsMax Specifies maximum number of StreamIds supported