'\" t
.\"     Title: ocf_heartbeat_nvmet-port
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_NVMET" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_nvmet-port \- NVMe\-oF target export agent
.SH "SYNOPSIS"
.HP \w'\fBnvmet\-port\fR\ 'u
\fBnvmet\-port\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
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\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBport_id\fR
.RS 4
The NVMe port number is a 16 bit number\&.
.sp
(unique, optional, integer, default
0)
.RE
.PP
\fBtype\fR
.RS 4
The NVMe transport type\&. Should be one of \*(Aqtcp\*(Aq, \*(Aqrdma\*(Aq, \*(Aqfc\*(Aq or \*(Aqloop\*(Aq\&.
.sp
(optional, string, default "tcp")
.RE
.PP
\fBaddr_fam\fR
.RS 4
The address family of the address\&. Should be \*(Aqipv4\*(Aq, \*(Aqipv6\*(Aq or \*(Aqfc\*(Aq\&.
.sp
(optional, string, default "ipv4")
.RE
.PP
\fBsvcid\fR
.RS 4
The transport service identifier\&. The TCP/IP port number this target binds to, or its RDMA protocol equivalent\&.
.sp
(optional, integer, default
4420)
.RE
.PP
\fBaddr\fR
.RS 4
The transport address\&. The TCP/IP address this targets binds to, or its RDMA protocol equivalent\&.
.sp
(required, string, no default)
.RE
.PP
\fBnqns\fR
.RS 4
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\&.
.sp
(required, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 10s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 10s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 10s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a nvmet\-port resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nvmet\-port ocf:heartbeat:nvmet\-port \e
  params \e
    addr=\fIstring\fR \e
    nqns=\fIstring\fR \e
  op monitor timeout="10s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a nvmet\-port resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nvmet\-port ocf:heartbeat:nvmet\-port \e
  addr=\fIstring\fR \e
  nqns=\fIstring\fR \e
  op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR