'\" t
.\"     Title: ocf_heartbeat_nvmet-subsystem
.\"    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-subsystem \- NVMe\-oF target export agent
.SH "SYNOPSIS"
.HP \w'\fBnvmet\-subsystem\fR\ 'u
\fBnvmet\-subsystem\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Manages NVMe\-oF subsystems\&. An NVMe\-oF subsystem is part of an NVMe\-oF target\&. A subsystem must be created first, before namespace(s) and port(s)\&.
.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
.sp
(unique, required, string, no default)
.RE
.PP
\fBallowed_initiators\fR
.RS 4
Allowed initiators\&. A space\-separated list of initiators allowed to connect to this target\&. Initiators are identified by their NQN\&. If the list is empty, any initiator will be allowed to connect\&.
.sp
(optional, string, no default)
.RE
.PP
\fBserial\fR
.RS 4
The serial of the subsystem\&. Set it to a random 16 character hex value\&. Use hexdump \-n 8 \-e \*(Aq4/4 "%08x" 1 "\en"\*(Aq /dev/urandom
.sp
(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\-subsystem resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_nvmet\-subsystem ocf:heartbeat:nvmet\-subsystem \e
  params \e
    nqn=\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\-subsystem resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_nvmet\-subsystem ocf:heartbeat:nvmet\-subsystem \e
  nqn=\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