'\" t
.\"     Title: ocf_heartbeat_nvmet-namespace
.\"    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-namespace \- NVMe\-oF target export agent
.SH "SYNOPSIS"
.HP \w'\fBnvmet\-namespace\fR\ 'u
\fBnvmet\-namespace\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Manages NVMe\-oF namespaces\&. An NVMe\-oF namespace is part of an NVMe\-oF target\&. A namespace must be created after the subsystem\&. It is similar in concept to the LUN of an iSCSI target\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBnqn\fR
.RS 4
The NVMe Qualified Name (NQN) is used to identify the remote NVMe storage target\&. It is similar to an iSCSI Qualified Name (IQN)\&. While it is a free\-form string, you should follow the convention: nqn\&.2014\-08\&.com\&.vendor:nvme:nvm\-subsystem\-sn\-12345 You need to refer here to the NQN of an NVMe Subsystem your created with the NVMeSubsystem resource agent\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBnamespace_id\fR
.RS 4
The NVMe namespace id (number)\&.
.sp
(unique, optional, integer, default
1)
.RE
.PP
\fBbacking_path\fR
.RS 4
The full path to the block device or file that should be exposed through this namespace\&.
.sp
(required, string, no default)
.RE
.PP
\fBuuid\fR
.RS 4
The UUID that should be exposed by NVMe\&. Create it using uuidgen\&. This is necessary for the initiators to accept the namespace from the new server after failover\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBnguid\fR
.RS 4
NGUID stands for Namespace Globally Unique Identifier\&. Seems to be optional, looks like e\&.g\&. VMWare ESXi7 uses it to identify namespaces\&. Use \*(Aquuidgen\*(Aq to create it\&.
.sp
(unique, optional, 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\-namespace resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nvmet\-namespace ocf:heartbeat:nvmet\-namespace \e
  params \e
    nqn=\fIstring\fR \e
    backing_path=\fIstring\fR \e
    uuid=\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\-namespace resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nvmet\-namespace ocf:heartbeat:nvmet\-namespace \e
  nqn=\fIstring\fR \e
  backing_path=\fIstring\fR \e
  uuid=\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