nvmf_tcp_port

05/08/2024 Contributors

An NVMe/TCP port is a logical interface that connects a SVM to a physical TCP capable device. This table collects diagnostics and performance information for an NVMe/TCP port. The table counters can be used to debug and diagnose connectivity issues with initiators or fabric on a LIF. The table counters can be used to debug and diagnose connectivity issues with initiators or fabric at a LIF level granularity. The alias names for nvmf_tcp_port:port and nvmf_tcp_port:node are nvmf_tcp_port_port and nvmf_tcp_port_node respectively.

Classic Object: nvmf_tcp_port

Table Row IDs

ID Format	Aggregation Type	Comment
{instance_name}:{instance_uuid}	(not applicable)	This represents the construction of the row ID field, which is a single unique string that identifies a row.
{node.name}:{instance_name}:{instance_uuid}	constituent	This represents the construction of a row ID field for a row from a single node.
{port.id}:{port_ip_addr}	port	This represents the construction of the row ID field in port combo object, which is a single unique string that identifies a row.
{node.name}:{node.uuid}	node	This represents the construction of the row ID field in node combo object, which is a single unique string that identifies a row.

ID Format

Aggregation Type

Comment

{instance_name}:{instance_uuid}

(not applicable)

This represents the construction of the row ID field, which is a single unique string that identifies a row.

{node.name}:{instance_name}:{instance_uuid}

constituent

This represents the construction of a row ID field for a row from a single node.

{port.id}:{port_ip_addr}

port

This represents the construction of the row ID field in port combo object, which is a single unique string that identifies a row.

{node.name}:{node.uuid}

node

This represents the construction of the row ID field in node combo object, which is a single unique string that identifies a row.

Properties

This section describes the mapping between classic (ONTAPI) string counter names and REST property names.

Classic String Counter	REST Property	Description
node_name	node.name	Name of the node hosting the TCP logical interface
node_uuid	node.uuid	UUID of the node hosting the TCP logical interface
instance_name	name	Name of the row.
instance_uuid	uuid	Unique identifier (UUID) for the row.
vserver_name	svm.name	Name of the SVM that owns this logical interface (LIF)
vserver_uuid	svm.uuid	UUID of the SVM that owns this logical interface (LIF)
port_ip_addr	port_ip_addr	ID for the port
port_id	port.id	ID for the port

Classic String Counter

REST Property

Description

node_name

node.name

Name of the node hosting the TCP logical interface

node_uuid

node.uuid

UUID of the node hosting the TCP logical interface

instance_name

name

Name of the row.

instance_uuid

uuid

Unique identifier (UUID) for the row.

vserver_name

svm.name

Name of the SVM that owns this logical interface (LIF)

vserver_uuid

svm.uuid

UUID of the SVM that owns this logical interface (LIF)

port_ip_addr

ID for the port

port_id

port.id

ID for the port

Counters

This section describes the mapping between classic (ONTAPI) numeric counter names and REST counter names.

Classic Numeric Counter	REST Counter	Description
read_ops	read_ops	Number of read operations
write_ops	write_ops	Number of write operations
other_ops	other_ops	Number of operations that are not read, write, compare or compare-and-write.
total_ops	total_ops	Total number of operations.
read_data	read_data	Amount of data read from the storage system
write_data	write_data	Amount of data written to the storage system
total_data	total_data	Amount of NVMF traffic to and from the storage system
avg_read_latency	average_read_latency	Average latency for read operations
avg_write_latency	average_write_latency	Average latency for write operations
avg_other_latency	average_other_latency	Average latency for operations other than read, write, compare or compare-and- write
avg_latency	average_latency	Average latency for NVMF operations

Classic Numeric Counter

REST Counter

Description

read_ops

Number of read operations

write_ops

Number of write operations

other_ops

Number of operations that are not read, write, compare or compare-and-write.

total_ops

Total number of operations.

read_data

Amount of data read from the storage system

write_data

Amount of data written to the storage system

total_data

Amount of NVMF traffic to and from the storage system

avg_read_latency

average_read_latency

Average latency for read operations

avg_write_latency

average_write_latency

Average latency for write operations

avg_other_latency

average_other_latency

Average latency for operations other than read, write, compare or compare-and-
write

avg_latency

average_latency

Average latency for NVMF operations

Property/Counter Content Changes

This section describes any output value differences between the classic (ONTAPI) string counter and the respective REST property. It also describes array label name changes between classic array counters and respective REST array counters.

Table Aliases

This section describes aliases for aggregated tables.

Classic Object	Alias
nvmf_tcp_port:port	nvmf_tcp_port_port
nvmf_tcp_port:node	nvmf_tcp_port_node

Classic Object

Alias

nvmf_tcp_port:port

nvmf_tcp_port_port

nvmf_tcp_port:node

nvmf_tcp_port_node