---
name: "ocf_heartbeat_nvmet-port"
section: "7"
platform: "linux"
package: "resource-agents"
version: "1:4.16.0-3+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ocf_heartbeat_nvmet-port"
---

# ocf\_heartbeat\_nvmet-port(7)

NVMe-oF target export agent

## NAME

ocf\_heartbeat\_nvmet-port - NVMe-oF target export agent

## SYNOPSIS

**nvmet-port** \[start \| stop \| status \| monitor \| meta-data \| validate-all\]

## DESCRIPTION

Manages NVMe-oF ports. An NVMe-oF port is part of an NVMe-oF target. A port must be created after the subsystem. It exposes one or multiple subsystem(s) including the enclosed namespace(s) to the network.

## SUPPORTED PARAMETERS

**port\_id**

The NVMe port number is a 16 bit number.

(unique, optional, integer, default 0)

**type**

The NVMe transport type. Should be one of 'tcp', 'rdma', 'fc' or 'loop'.

(optional, string, default "tcp")

**addr\_fam**

The address family of the address. Should be 'ipv4', 'ipv6' or 'fc'.

(optional, string, default "ipv4")

**svcid**

The transport service identifier. The TCP/IP port number this target binds to, or its RDMA protocol equivalent.

(optional, integer, default 4420)

**addr**

The transport address. The TCP/IP address this targets binds to, or its RDMA protocol equivalent.

(required, string, no default)

**nqns**

A space-separated list of NQNs that should be exported through this NVMe-oF-Target port. This list needs to have at least one entry.

(required, string, no default)

## SUPPORTED ACTIONS

This resource agent supports the following actions (operations):

**start**

Starts the resource. Suggested minimum timeout: 10s.

**stop**

Stops the resource. Suggested minimum timeout: 10s.

**status**

Performs a status check. Suggested minimum timeout: 10s. Suggested interval: 10s.

**monitor**

Performs a detailed status check. Suggested minimum timeout: 10s. Suggested interval: 10s.

**meta-data**

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

**validate-all**

Performs a validation of the resource configuration. Suggested minimum timeout: 10s.

## EXAMPLE CRM SHELL

The following is an example configuration for a nvmet-port resource using the [**crm**(8)](/crm/8.md) shell:

```
primitive p_nvmet-port ocf:heartbeat:nvmet-port \
  params \
    addr=string \
    nqns=string \
  op monitor timeout="10s" interval="10s" depth="0"
```

## EXAMPLE PCS

The following is an example configuration for a nvmet-port resource using [**pcs**(8)](/pcs/8.md)

```
pcs resource create p_nvmet-port ocf:heartbeat:nvmet-port \
  addr=string \
  nqns=string \
  op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
```

## SEE ALSO

**http://clusterlabs.org/**

## AUTHOR

**ClusterLabs contributors (see the resource agent source for information about individual authors)**